public
networks

Get a private network

get/v1/networks/{id}

Request

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

Path parameters

idstring required

network id (uuid)

Response

OK

cidrstring
created_atstring
failure_reason'terminal_error' | 'max_attempts' | 'provisioning_deadline' nullable

Why this network is in the failed state: terminal_error (the provider refused it; recreating will not help without a change), max_attempts (it was retried and never succeeded), or provisioning_deadline (it ran out of time). null on any network that has not failed.

idstring
member_countinteger
namestring
state'pending' | 'active' | 'deleting' | 'failed' | 'deleted'

The network lifecycle state. A failed network is terminal: delete it and create a new one. See failure_reason for why it failed.

updated_atstring

When this network last changed state, RFC3339 UTC.

zonestring

The slug of the zone the network is in. Absent when the zone is not known. GET /v1/zones lists the zones open for new orders, so a network 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.