Cycle Docs | API Reference | List Pool IP Addresses

List Pool IP Addresses

Fetch a list of IPs that are associated with the specified pool.

Requires the ips-manage permission.

query

sort

Sorts can be performed on any field - see sorting
filter

Collections of resources can be filtered based on certain criteria - see filtering

Returns

Returns a list of IP resources associated with this pool, otherwise returns an Error.

IP Resource

id
string
The ID of the IP address.
hub_id
string
The ID of the hub the IP is associated with.
kind
string
The type of IP address, either ipv4 or ipv6
assignment
object | null
Information about the instance this IP is assigned to, if any. Otherwise will be null.
Show child fields
pool_id
string
The ID of the pool the IP is associated with.
address
string
The actual IP address.
gateway
string
The gateway IP address.
cidr
string
The CIDR for this address.
state
object
Information regarding the current state of the ip address.
Show child fields

GET /v1/infrastructure/ips/pools/{ID}/ips

Example Request

$ curl https://api.cycle.io/v1/infrastructure/ips/pools/5c7369bc4c51ea0001b32c40/ips \
  -H "Authorization: Bearer API_KEY"
 \
  -H "X-Hub-Id: HUB_ID"

Example Response

{
  "data": [
    {
      "id": "5c7741714c51ea0001d92c3d",
      "hub_id": "5a6b6f3df231a50001c2317c",
      "kind": "ipv4",
      "assignment": {
        "container_id": "5c77ddaad9e45200013884bc",
        "instance_id": "5c77ddaed9e45200013884c1",
        "environment_id": "5aa1e669f231a50001cb3b4f"
      },
      "pool_id": "5c77416f4c51ea0001d92c3c",
      "address": "147.0.0.0",
      "gateway": "147.0.0.0",
      "cidr": "147.0.0.0/32",
      "state": {
        "changed": "2019-02-28T13:10:07.144Z",
        "current": "assigned"
      }
    }
  ]
}