List Environment IP Addresses
Lists IP addresses assigned to the load balancer for this instance's environment.
Attributes
- idstring
The ID of the IP address.
- hub_idstring
The ID of the hub this IP address is associated with.
- kindstring
The kind of IP address, either
ipv4
oripv6
. - assignmentarray of objects
IDs of instance/container/environment that this IP address is assigned to.
Show child fields - pool_idstring
The ID of the pool (requested from provider) this IP address is a part of.
- host_nat_ipstring | null
The IP address on the host where NAT translations are done (if any).
- addressstring | null
The actual IP address.
- gatewaystring | null
The IP address of the gateway.
- cidrstring | null
The size of the space this IP address is a part of (CIDR).
- stateobject
Information regarding the current state of the IP address.
Show child fields
Returns
Returns a list of IP addresses, otherwise returns an Error.
GET /v1/environment/ips
Example Request
$ curl --unix-socket /var/run/cycle/api/api.sock http://internal.cycle/v1/environment/ips \-H "x-cycle-token: $CYCLE_API_TOKEN"
Example Response
{"data": [{"id": "2lkj3278b6393d0001f32llk","hub_id": "2lkj3278b6393d0001f32llk","kind": "ipv4","assignment": {"container_id": "2lkj3278b6393d0001f32llk","instance_id": "2lkj3278b6393d0001f32llk","environment_id": "2lkj3278b6393d0001f32llk"},"pool_id": "2lkj3278b6393d0001f32llk","host_nat_ip": null,"address": "104.123.145.215","gateway": "104.123.145.215","cidr": "104.123.145.215/32","state": {"changed": "2020-01-14T19:12:51.643Z","job": {"id": "","queued": "0001-01-01T00:00:00Z","queue": ""},"current": "assigned"}},{"id": "2lkj3278b6393d0001f32llk","hub_id": "2lkj3278b6393d0001f32llk","kind": "ipv6","assignment": {"container_id": "2lkj3278b6393d0001f32llk","instance_id": "2lkj3278b6393d0001f32llk","environment_id": "2lkj3278b6393d0001f32llk"},"pool_id": "2lkj3278b6393d0001f32llk","host_nat_ip": null,"address": "2001:19f0:6401:1d79::101","gateway": "2001:19f0:6401:1d79::100","cidr": "2001:19f0:6401:1d79::100/121","state": {"changed": "2020-01-14T19:12:51.84Z","job": {"id": "","queued": "0001-01-01T00:00:00Z","queue": ""},"current": "assigned"}}]}