Get Proxy Configuration

Get Proxy Configuration

Retrieves a specific proxy configuration.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/proxyConfigurations/{id}
COPY
Path Parameters
string
id
Required

Proxy Configuration ID URN

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProxyConfiguration of type(s) application/json;version=39.1 
{
    "name": "Proxy Sample Name",
    "id": "string",
    "description": "Configuration to connect to VC-1",
    "authType": "string",
    "username": "string",
    "password": "string",
    "token": "string",
    "host": "sampleProxy.vmware.com",
    "port": 0
}
string As .*[\S].*
name
Required
Constraints: maxLength: 128

name

string
id
Optional

id

string
description
Optional

Optional description.

string
authType
Required

the type of authentication. 'NO_AUTH' is for an unauthenticated proxy, 'BASIC' is for basic authentication.

string
username
Optional
Constraints: maxLength: 32

username to connect to the proxy server.

string
password
Required
Constraints: maxLength: 128

password to connect to the proxy server, when auth type is Basic.

string
token
Optional

authentication token to connect to the proxy server, when auth type is Bearer.

string
host
Required
Constraints: maxLength: 1004

hostname of the proxy server.

integer
port
Required

port of the proxy server.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/proxyConfigurations/{id}
Availability
Added in 34.0
On This Page
Proxy Configuration Operations
GET
Query Proxy Configurations
POST
Create Proxy Configuration
GET
Get Proxy Configuration
PUT
Update Proxy Configuration
DELETE
Delete Proxy Configuration