Create Proxy Rule

Create Proxy Rule

Creates a proxy rule.

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

The new proxy rule definition.

proxyRule of type(s) application/json
Required 
{
    "id": "string",
    "name": "Proxy Sample Name",
    "destination": "https://deadend.intranet.vmware.com:10101",
    "proxy": {
        "name": "string",
        "id": "string"
    },
    "priority": 0
}
string
id
Optional

id

string As .*[\S].*
name
Required

The proxy rule name.

string As uri As uri
destination
Required

The URL of the destination that must be accessed via the proxy. Only, the scheme, host and port will be retained. Any authority section, query parameters, matrix parameters or fragments will be ignored. Only http and https schemes are supported.

EntityReference
proxy
Required

Entity reference used to describe VCD entities

integer As int32 As int32
priority
Optional

Indicates the relative preference of this rule over other rules for the same destination. A lower numerical value indicates a higher priority. The minimum (and therefore highest) priority is 0.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns proxyRule of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "Proxy Sample Name",
    "destination": "https://deadend.intranet.vmware.com:10101",
    "proxy": {
        "name": "string",
        "id": "string"
    },
    "priority": 0
}
string
id
Optional

id

string As .*[\S].*
name
Required

The proxy rule name.

string As uri As uri
destination
Required

The URL of the destination that must be accessed via the proxy. Only, the scheme, host and port will be retained. Any authority section, query parameters, matrix parameters or fragments will be ignored. Only http and https schemes are supported.

EntityReference
proxy
Required

Entity reference used to describe VCD entities

integer As int32 As int32
priority
Optional

Indicates the relative preference of this rule over other rules for the same destination. A lower numerical value indicates a higher priority. The minimum (and therefore highest) priority is 0.


Availability
Added in 38.0
On This Page
Proxy Rules Operations
POST
Create Proxy Rule
DELETE
Delete Proxy Rule
GET
Get Proxy Rule
GET
Query Proxy Rules
PUT
Update Proxy Rule