Get External Network

Get External Network

Retrieves a specific external network.

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

externalNetworkId

string
externalNetworkId
Required

externalNetworkId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ExternalNetwork of type(s) application/json;version=39.0
This response body class contains all of the following: Network , NetworkingObjectStatus , InlineExternalNetwork2 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "subnets": {
        "values": [
            {
                "gateway": "string",
                "prefixLength": 0,
                "dnsSuffix": "string",
                "dnsServer1": "string",
                "dnsServer2": "string",
                "ipRanges": {
                    "values": [
                        {
                            "startAddress": "string",
                            "endAddress": "string"
                        }
                    ]
                },
                "enabled": false,
                "totalIpCount": 0,
                "usedIpCount": 0
            }
        ]
    },
    "status": {},
    "networkBackings": {
        "values": [
            {
                "backingId": "string",
                "backingType": {},
                "backingTypeValue": "string",
                "networkProvider": {
                    "name": "string",
                    "id": "string"
                },
                "name": "string",
                "isNsxTVlanSegment": false,
                "parentTier0Ref": {
                    "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                    "name": "string",
                    "type": "string"
                }
            }
        ]
    },
    "totalIpCount": 0,
    "usedIpCount": 0,
    "dedicatedOrg": {
        "name": "string",
        "id": "string"
    },
    "dedicatedEdgeGateway": {
        "name": "string",
        "id": "string"
    },
    "usingIpSpace": false,
    "networkRouteAdvertisementIntention": "string",
    "natAndFirewallServiceIntention": "string",
    "vpnServiceIntention": "string",
    "strictIpMode": false
}

404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.0
On This Page
External Network Operations
DELETE
Delete External Network
GET
Get Available Ip Addresses
GET
Get Edge Gateways For Provider Gateway Topology
GET
Get External Network
GET
Get Ip Space Uplinks For Provider Gateway Topology
GET
Get Provider Gateway Ip Space Migration Violations
GET
Get Used Ip Addresses
POST
Migrate Provider Gateway To Use Ip Spaces
PUT
Update External Network