Get Proxy Rule

Get Proxy Rule

Retrieves a specific proxy rule.

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

Proxy Configuration ID URN

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns proxyRule of type(s) application/json;version=39.1 
{
    "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
Constraints: maxLength: 128

The proxy rule name.

string As uri As uri
destination
Required
Constraints: maxLength: 2000

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.

object
proxy
Required

Entity reference used to describe VCD entities

integer As int32 As int32
priority
Optional
Constraints: minimum: 0 default: 0

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.


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