Fetch Instance

Fetch a specific instance by ID.

Requires the containers-view permission.

query
  • include

    Accepted Values: creatorserverslocationsproviders

Returns

Returns a container instance resource, otherwise returns an Error.

GET /v1/containers/{CONTAINER_ID}/instances/{INSTANCE_ID}

Example Request
$ curl https://api.cycle.io/v1/containers/5b9c2a77b6393d0001eb45fd/instances/5cc78aa0db2ab000014a8b98 \
-H
"Authorization: Bearer API_KEY"
\
-H
"X-Hub-Id: HUB_ID"
Example Response
{
"data": {
"id": "5cc78aa0db2ab000014a8b98",
"creator": {
"id": "5a232a77b6393d0001ac2df2",
"type": "account"
},
"hub_id": "5ccc2a2226393d1231eb4abd",
"container_id": "5cc78a8adb2ab000014a8b8a",
"location_id": "5c1ab90821638910ec95558a",
"environment": {
"id": "5cc78a8a4146380001c5b21f",
"subnet": "1",
"mac_addr": "00-15-E9-2B-99-3C",
"ipv6": {
"ip": "fd00::425e:eaec:1:1",
"cidr": "fd00::425e:eaec:1:1/112"
},
"legacy": {
"host": 22,
"ipv4": {
"ip": "10.183.47.22",
"cidr": "10.183.47.22/16"
},
"subnet": 1
}
},
"stateful": null,
"provider": {
"identifier": "equinix-metal",
"location": "2b70eb8f-fa18-47c0-aba7-222a842362fd"
},
"server_id": "5a14de0a78ecdb000128b9ec",
"ready_state": "active",
"hostname": "web",
"migration": {
"to": {
"instance_id": "5a14de0a78ecdb000128b9ec",
"server_id": "5a14de0a78ecdb000128b9ec"
},
"from": {
"instance_id": "5a14de0a78ecdb000128b9ec",
"server_id": "5a14de0a78ecdb000128b9ec"
},
"key": "5cc78aa0db2ab000014a8b98",
"copy_volumes": false
},
"purge_time": "2019-04-29T23:37:04.571Z",
"service": null,
"state": {
"changed": "2019-06-18T04:49:55.522Z",
"current": "running",
"health": {
"healthy": true,
"updated": "2021-04-29T23:37:04.571Z"
}
},
"events": {
"created": "2019-04-29T23:37:04.571Z",
"updated": "0001-01-01T00:00:00Z",
"deleted": "0001-01-01T00:00:00Z",
"first_started": "0001-01-01T00:00:00Z"
}
}
}