Get managed VM box definition

GET

/v1/ns/{nsid}/resources/vm-boxes/{context}/{box}

curl --request GET \
  --url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resources/vm-boxes/example/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Parameters

Path Parameters

nsid

required

string format: uuid

Namespace UUID

context

required

string

box

required

string

Responses

200

OK

Media typeapplication/json

object

success

boolean

vm_box

object

context

string

box

string

members

Array<string>

greeting_recording

string

Example^generated

{
  "success": true,
  "vm_box": {
    "context": "example",
    "box": "example",
    "members": [
      "example"
    ],
    "greeting_recording": "example"
  }
}

default

Error response

Media typeapplication/problem+json

RFC 7807 Problem Details

object

type

Problem type slug URI

string

title

string

status

integer

detail

string

key

additional properties

any

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}