Get instance details
GET
/v2/instances/{instanceId}
Authorizations
bearerAuth
OAuth access token or an API key on operations declaring x-api-key-scopes. Example header - Authorization Bearer sk_<64 lowercase hex characters>.
Type
HTTP (bearer)
or
basicAuth
Type
HTTP (basic)
Parameters
Query Parameters
full
Any nonempty value expands related resources, including the string "false". Omit for the basic representation.
Type
string
Example
"true"Responses
Instance details
application/json
JSON "id": "string", "name": "string", "nodeId": "string", "planId": "string", "imageId": "string", "createdAt": "2024-01-01T00:00:00Z", "isSettingUp": true, "autoExtend": true, "expiresAt": "2024-01-01T00:00:00Z", "node": { "id": "string", "type": "PROXMOX", "region": { "id": "string", "code": "string" } }, "image": { "id": "string", "name": "string", "type": "PROXMOX" }, "plan": { "id": "string", "name": "string", "type": "PROXMOX", "config": "string", "lineupId": "string", "price": 0 }, "price": 0, "owners": [ { "sub": "string", "preferred_username": "string", "nickname": "string", "name": "string" } ], "internetProtocolAddresses": [ { "id": "string", "address": "string", "subnet": "string", "gateway": "string", "type": "IPV4" } ]
{
}