List active boxes in a context
GET
/v1/ns/{nsid}/vm/boxes/{context}
const url = 'https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vm/boxes/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://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vm/boxes/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”nsid
required
string format: uuid
Namespace UUID
context
required
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
success
required
boolean
boxes
required
Array<object>
object
context
required
string
box
required
string
unread
required
integer
read
required
integer
urgent_unread
required
integer
provisioned
required
boolean
Examplegenerated
{ "success": true, "boxes": [ { "context": "example", "box": "example", "unread": 1, "read": 1, "urgent_unread": 1, "provisioned": true } ]}default
Section titled “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
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example"}