Get Edge Gateways For Provider Gateway Topology

Get all the Edge Gateways which are associated with this Provider Gateway.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/topology/edgeGateways

COPY

Path Parameters

string

externalNetworkId

Required

externalNetworkId

string

externalNetworkId

Required

externalNetworkId

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.

ApiKeyAuth

Responses

200

Returns TopologyEdgeGateways of type(s) application/json;version=39.0

This response body class contains all of the following: Page , InlineTopologyEdgeGateways1

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "edgeGatewayRef": {
                "name": "string",
                "id": "string"
            },
            "description": "string",
            "edgeGatewayOwnerRef": {
                "name": "string",
                "id": "string"
            },
            "connected": false,
            "orgRef": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}

Availability

Added in 37.1

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

External Network Operations

DELETE