logo

IPs

Endpoints for managing IP allocations.

List IP Pools

Requires the infrastructure-ips-manage capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "servers" "integrations" "locations"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

A list of IP Pools.

default

General error response from the platform

get/v1/infrastructure/ips/pools
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Get IP Pool

Requires the infrastructure-ips-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
poolId
required
string

The ID for the given pool.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "servers" "integrations" "locations"
Responses
200

An IP Pool.

default

General error response from the platform

get/v1/infrastructure/ips/pools/{poolId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Delete IP Pool

Requires the infrastructure-ips-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
poolId
required
string

The ID for the given IP Pool.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/infrastructure/ips/pools/{poolId}
Response samples
application/json
{
  • "data": {
    }
}

List Pool IPs

Requires the infrastructure-ips-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
poolId
required
string

The ID of the IP Pool to fetch the IPs of.

Responses
200

A list of IPs.

default

General error response from the platform

get/v1/infrastructure/ips/pools/{poolId}/ips
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Jobs