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

Retrieve HTTP proxy configurations for all SVMs and cluster IPspaces

Contributors
PDFs

GET /network/http-proxy

Introduced In: 9.7

Retrieves the HTTP proxy configurations of all the SVMs and Cluster IPspaces.

  • vserver http-proxy show

Parameters

Name Type In Required Description

ipspace.uuid

string

query

False

Filter by ipspace.uuid

ipspace.name

string

query

False

Filter by ipspace.name

authentication_enabled

boolean

query

False

Filter by authentication_enabled

  • Introduced in: 9.9

server

string

query

False

Filter by server

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

uuid

string

query

False

Filter by uuid

scope

string

query

False

Filter by scope

port

integer

query

False

Filter by port

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of HTTP proxy records

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"
      },
      "password": "string",
      "port": 3128,
      "scope": "string",
      "server": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "username": "string",
      "uuid": "string"
    }
  ]
}

Error

Status: Default, Error
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

next

href

self

href

_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

authentication_enabled

boolean

Specifies whether or not authentication with the HTTP proxy server is enabled.

ipspace

ipspace

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

password

string

Password to authenticate with the HTTP proxy server when authentication_enabled is set to "true".

port

integer

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

scope

string

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

server

string

Fully qualified domain name (FQDN) or IP address of the HTTP proxy server.

svm

svm

username

string

Username to authenticate with the HTTP proxy server when authentication_enabled is set to "true".

uuid

string

The UUID that uniquely identifies the HTTP proxy.

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.