Skip to main content
REST API reference
A newer release of this product is available.

Create an http proxy configuration for an SVM or cluster IPspace

PDFs

POST /network/http-proxy

Creates an HTTP proxy configuration for an SVM or a Cluster IPspace. Important notes:

  • IPv6 must be enabled if IPv6 family addresses are specified in the "server" field.

  • The server and the port combination specified using the "server" and "port" fields is validated during this operation. The validation will fail in the following scenarios:

    • The HTTP proxy service is not configured on the server.

    • The HTTP proxy service is not running on the specified port.

    • The server is unreachable.

Required properties

  • SVM-scoped HTTP proxy

    • svm.uuid or svm.name - Existing SVM in which to create the HTTP proxy.

  • Cluster-scoped HTTP proxy

    • ipspace.uuid or ipspace.name - Exisitng Cluster IPspace in which to create the HTTP proxy.

  • server - HTTP proxy server FQDN or IP address.

  • port - HTTP proxy server port.

  • vserver http-proxy create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

_links

ipspace

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.

port

integer

The port number on which the HTTP proxy service is configured on the proxy server.

scope

string

Set to “svm” for proxy owned by an SVM. Otherwise, set to "cluster".

server

string

The fully qualified domain name (FQDN) or IP address of the proxy server.

svm

svm

uuid

string

The UUID that uniquely identifies the HTTP proxy.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "port": 3128,
  "scope": "string",
  "server": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "string"
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

records

array[network_http_proxy]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "ipspace": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "exchange",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "port": 3128,
      "scope": "string",
      "server": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "uuid": "string"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

26214473

HTTP proxy configuration is not valid.

26214476

The "IPspace" parameter should not be specified in the SVM context.

26214477

The specified IPspace does not exist.

23724130

Cannot use an IPv6 name server address because there are no IPv6 interfaces.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

network_http_proxy

Name Type Description

_links

_links

ipspace

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input.

port

integer

The port number on which the HTTP proxy service is configured on the proxy server.

scope

string

Set to “svm” for proxy owned by an SVM. Otherwise, set to "cluster".

server

string

The fully qualified domain name (FQDN) or IP address of the proxy server.

svm

svm

uuid

string

The UUID that uniquely identifies the HTTP proxy.

_links

Name Type Description

next

href

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.