Create Proxy Configuration

Create Proxy Configuration

Creates a proxy configuration.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/proxyConfigurations
COPY
Request Body

The new proxy configuration API model.

ProxyConfiguration of type(s) application/json
Required

Show optional properties

{
    "name": "Proxy Sample Name",
    "authType": "string",
    "password": "string",
    "host": "sampleProxy.vmware.com",
    "port": 0
}
{
    "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.

Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"authType:"string","host:"string","name:"string","password:"string","port:"integer"}' https://{api_host}/cloudapi/1.0.0/proxyConfigurations
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