/v1/instances/{instanceId}

GET

const url = 'https://service.v2.nairon.xyz/v1/instances/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://service.v2.nairon.xyz/v1/instances/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyHeader

Parameters

Path Parameters

instanceId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

Responses

200

Default Response

application/json

object

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

templateId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

templateVersionId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

organizationId

required

string format: cuid

/^[cC][0-9a-z]{6,}$/

projectId

required

Any of:

string
null

string format: cuid

/^[cC][0-9a-z]{6,}$/

name

required

string

fieldValues

required

status

required

string

Allowed values: provisioning active update_available updating failed archived

createdAt

required

string

updatedAt

required

string

Example

{
  "status": "provisioning"
}