Get Application Port Profiles

Get Application Port Profiles

Retrieves all Application Port Profiles. This includes user-defined profiles and default system profile. Supported filters are:

  • Org vDC ID (orgVdcId==[ID]) - | Return all the application port profiles which are available to a specific Org vDC.
  • Network Provider ID (networkProviderId==[ID]) - | Returns all the application port profiles which are available under a specific network provider.
  • VDC Group ID (vdcGroupId==[ID]) - | Returns all the application port profiles which are available to a specific vDC Group.
  • Provider Gateway ID (providerGatewayId==[ID]) - | Returns all the application port profiles which are available to a specific Provider Gateway.
The following contexts are deprecated as of API version 38.0: Org vDC ID (_context==orgVdcId), Network Provider ID (_context==networkProviderId), VDC Group ID (_context==vdcGroupId)
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/applicationPortProfiles
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ApplicationPortProfiles of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineApplicationPortProfiles1
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "orgRef": {
                "name": "string",
                "id": "string"
            },
            "contextEntityId": "string",
            "networkProviderScope": "string",
            "status": {},
            "id": "string",
            "name": "string",
            "description": "string",
            "scope": "string",
            "applicationPorts": [
                {
                    "name": "string",
                    "protocol": "string",
                    "destinationPorts": [
                        "string"
                    ]
                }
            ],
            "usableForNAT": false
        }
    ]
}