Get Available Ip Addresses

Get Available Ip Addresses

Get all the available IPs for a given external network.

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

externalNetworkId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AvailableIpPoolSubnets of type(s) application/json;version=39.1 
{
    "values": [
        {
            "gateway": "string",
            "prefixLength": 0,
            "enabled": false,
            "ipRanges": {
                "values": [
                    {
                        "startAddress": "string",
                        "endAddress": "string"
                    }
                ]
            },
            "totalIpCount": 0
        }
    ]
}
array of object
values
Optional

Describes an available IP address.


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.1 
"Error Object"
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/externalNetworks/{externalNetworkId}/availableIpAddresses
Availability
Added in 33.0
On This Page
External Network Operations
GET
Get External Network
PUT
Update External Network
DELETE
Delete External Network
GET
Get Used Ip Addresses
GET
Get Available Ip Addresses
GET
Get Edge Gateways For Provider Gateway Topology
GET
Get Ip Space Uplinks For Provider Gateway Topology
GET
Get Provider Gateway Ip Space Migration Violations
POST
Migrate Provider Gateway To Use Ip Spaces