Cycle Docs | API Reference | List Environment Instances

List Environment Instances

Lists all instances that are in the same environment as this instance.

Returns

Returns a list of container instance resources, otherwise returns an Error.

GET /v1/environment/instances

Example Request

$ curl --unix-socket /var/run/cycle/api/api.sock http://internal.cycle/v1/environment/instances \
  -H "x-cycle-token: $CYCLE_API_TOKEN"

Example Response

{
  "data": [
    {
      "id": "2lkj3278b6393d0001f32llk",
      "creator": {
        "id": "2lkj3278b6393d0001f32llk",
        "type": "account"
      },
      "hub_id": "2lkj3278b6393d0001f32llk",
      "container_id": "5e28df9c41463800019e7730",
      "location_id": "2lkj3278b6393d0001f32llk",
      "environment": {
        "id": "2lkj3278b6393d0001f32llk",
        "network_subnet": "f4f0",
        "subnet": "1",
        "ipv6": {
          "ip": "fd00::f4f0:645b:1:1",
          "cidr": "fd00::f4f0:645b:1:1/112"
        },
        "legacy": null,
        "mac_addr": "96:7e:94:40:e7:ff",
        "vxlan_tag": 18001
      },
      "stateful": null,
      "provider": {
        "identifier": "vultr",
        "location": "3"
      },
      "server_id": "2lkj3278b6393d0001f32llk",
      "ready_state": "active",
      "hostname": "redis",
      "service": null,
      "state": {
        "changed": "2020-01-23T00:02:21.16Z",
        "job": {
          "id": "",
          "queued": "0001-01-01T00:00:00Z",
          "queue": ""
        },
        "current": "running",
        "health": null
      },
      "migration": null,
      "events": {
        "created": "2020-01-22T23:49:48.214Z",
        "updated": "0001-01-01T00:00:00Z",
        "deleted": "0001-01-01T00:00:00Z",
        "first_start": "0001-01-01T00:00:00Z",
        "started": "0001-01-01T00:00:00Z"
      }
    }
  ]
}