Skip to main content
GET
/
api
/
instances
/
{id}
Get an instance
curl --request GET \
  --url https://operator.io/api/instances/{id} \
  --header 'Authorization: Bearer <token>'
{
  "instance": {
    "id": "<string>",
    "name": "<string>",
    "status": "provisioning",
    "imageTag": "<string>",
    "avatarUrl": "<string>",
    "fqdn": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key (ck_live_...). Create one in Settings > API Keys.

Path Parameters

id
string
required

Response

Instance details.

instance
object