The IP Pool Resource

Cycle allows you to manage your IP addresses in groups, called pools.

For more information on infrastructure, see the main docs.

Attributes
  • id
    string

    The ID of the pool.

  • hub_id
    string

    The ID of the hub the pool is associated with.

  • kind
    string

    The type of IP address, either ipv4 or ipv6

  • provider
    object

    Contains details regarding the provider the server is associated with.

    Show child fields
  • server_id
    string

    A Cycle-specific ID referencing the server this pool is associated with.

  • floating
    bool

    Whether or not this IP Pool is "floating" and can be attached to an environment.

  • location_id
    string

    A Cycle-specific ID referencing the location/data center this IP pool is associated with.

  • ips
    object

    Stats for the number of available/total IP addresses in this pool.

    Show child fields
  • block
    object

    Information about the network this IP pool is associated with.

    Show child fields
  • state
    object

    Information regarding the current state of the IP pool.

    Show child fields
Example IP Pool
{
"id": "5c7369bc4c51ea0001b32c40",
"hub_id": "5a14ddd8b6393d0001976f44",
"kind": "ipv4",
"provider": {
"identifier": "equinix-metal",
"location": "2b70eb8f-fa18-47c0-aba7-222a8423ffff",
"reservation": "300ae906-fb05-4073-875e-2fb6f5afffff",
"server": "9b82a54f-e934-4c17-9da2-532e84f7ffff",
"server_assignment": "660f7faf-d01b-49af-9dba-d076eeaaffff"
},
"server_id": "5a14de0a78ecdb000128b9ec",
"floating": false,
"location_id": "5c1ab90821638910ec95558a",
"ips": {
"total": 1,
"available": 0
},
"block": {
"cidr": "147.0.0.0/32",
"gateway": "147.0.0.0",
"netmask": "255.255.255.255",
"network": "147.0.0.0"
},
"state": {
"changed": "0001-01-01T00:00:00Z",
"current": "live"
}
}