public
instances

Get an instance

An instance that does not exist and one belonging to another account are both 404.

get/v1/instances/{id}

Request

  • Base URL: https://api.vozora.io
  • URL: https://api.vozora.io/v1/instances/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

instance id (uuid)

Response

OK

created_atstring
desired_state'active' | 'suspended' | 'terminated'
display_namestring
dns_astring
dns_aaaastring
dns_ptrstring
idstring
ipv4_prefixstring
ipv6_prefixstring
primary_ipv4string

Addressing the customer legitimately needs to reach their own server.

primary_ipv6string
product_idstring
progressobject

Build progress: percent, the current step, and the per-step list. Present while the build is running, and on a build that failed; absent once the build has succeeded. Same shape as the progress object on an order.

resizableboolean

Whether this server can be resized. Absent when it could not be determined, which is not the same as false: treat an absent value as unknown rather than as a refusal. Present on a single instance read only.

status'pending' | 'provisioning' | 'active' | 'suspended' | 'terminating' | 'terminated' | 'failed'
tagsstring[]

The instance's tags, as last set by PUT /v1/instances/{id}/tags. Always present; an instance with no tags reports an empty array.

zonestring

The slug of the zone the server is in. Absent when the zone is not known. GET /v1/zones lists the zones open for new orders, so a server in a zone that has since closed to new orders names a zone that list omits.

Changes

No recorded changes to this operation across all 1 revision of this API.