Get IP Ranges With External Ids

Get IP Ranges With External Ids

Returns a collection of ip ranges with specified ids.

Request
URI
POST
https://{api_host}/ipam-service//api/providers/{providerEndpointId}/ip-ranges/searchExternalIds
COPY
Path Parameters
string
providerEndpointId
Required

The provider endpoint id, registered with the endpoint-service.

Query Parameters
boolean
isIPBlock
Optional

Boolean filter whether or not to return IP Blocks only.


Request Body

Collection of range IDs

Array of string of type(s) application/json
Optional
[
    {}
]
Responses
200

Success - return the collection of IPRanges for a given provider endpoint id.

[
    {
        "start": "string",
        "description": "string",
        "subnetPrefixLength": 0,
        "externalId": "string",
        "dnsInfo": {
            "alternateWINS": "string",
            "preferredWINS": "string",
            "primaryDNS": "string",
            "dnsSearchSuffixes": "string",
            "dnsSuffix": "string",
            "name": "string",
            "description": "string",
            "secondaryDNS": "string",
            "id": "string",
            "extensionData": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            }
        },
        "extensionData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "providerEndpointURI": "string",
        "addressSpaceId": "string",
        "ipVersion": "string",
        "providerEndpointId": "string",
        "name": "string",
        "end": "string",
        "id": "string",
        "gateway": "string"
    }
]

403

Forbidden.

Operation doesn't return any data structure

404

Resource not found.

Operation doesn't return any data structure