Cycle Docs | API Reference | List Environment Containers

List Environment Containers

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

Returns

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

GET /v1/environment/containers

Example Request

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

Example Response

{
  "data": [
    {
      "id": "5e28df9c41463800019e7730",
      "name": "redis",
      "identifier": "redis",
      "creator": {
        "id": "2lkj3278b6393d0001f32llk",
        "type": "account"
      },
      "environment": {
        "id": "5e1d3b9a4146380001f5a0d6",
        "container_subnet": "645b",
        "ipv6": {
          "ip": "fd00::f4f0:645b:0:0",
          "cidr": "fd00::f4f0:645b:0:0/96"
        },
        "legacy": null
      },
      "hub_id": "2lkj3278b6393d0001f32llk",
      "image": {
        "id": "2lkj3278b6393d0001f32llk",
        "service": null
      },
      "config": {
        "network": {
          "public": "egress-only",
          "hostname": "redis",
          "ports": null
        },
        "deploy": {
          "instances": 1,
          "strategy": null,
          "stateful": null,
          "constraints": {
            "node": {
              "tags": {
                "any": null,
                "all": null
              }
            },
            "secrets": null,
            "containers": null
          },
          "shutdown": null,
          "startup": null,
          "restart": null,
          "health_check": null,
          "update": null
        },
        "runtime": null,
        "scaling": null,
        "resources": null,
        "integrations": {
          "lets_encrypt": {
            "enable": false,
            "certificate_path": null,
            "chain_path": null,
            "key_path": null,
            "bundle_path": null,
            "additional_certs_path": null
          }
        }
      },
      "instances": 1,
      "stateful": false,
      "role": null,
      "state": {
        "changed": "2020-01-23T00:02:23.75Z",
        "job": {
          "id": "5e28e26ddb2ab00001c8ced0",
          "queued": "2020-01-23T00:01:49.143Z",
          "queue": "environment-2lkj3278b6393d0001f32llk"
        },
        "current": "running",
        "desired": "running"
      },
      "events": {
        "created": "2020-01-22T23:49:48.148Z",
        "updated": "0001-01-01T00:00:00Z",
        "deleted": "0001-01-01T00:00:00Z",
        "started": "2020-01-23T00:02:23.749Z"
      }
    }
  ]
}