Skip to content

Bulk upsert managed VM box definitions

POST
/v1/ns/{nsid}/resources/vm-boxes/bulk
curl --request POST \
--url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resources/vm-boxes/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[ { "context": "example", "box": "example", "members": [ "example" ], "greeting_recording": "example" } ]'

Best-effort batch of VM box definition writes; each item is validated and written independently and its outcome reported in order (one invalid item does not abort the rest). Each result id is the box’s “context/box” key. Subscriber-scale provisioning creates a box per line, so this spares a PUT per box.

nsid
required
string format: uuid

Namespace UUID

Media typeapplication/json
Array<object>
object
context
string
box
string
members
Array<string>
greeting_recording
string
Examplegenerated
[
{
"context": "example",
"box": "example",
"members": [
"example"
],
"greeting_recording": "example"
}
]

OK

Media typeapplication/json
object
success
required
boolean
results
required
Array<object>
object
name
string
ok
boolean
error
string
Examplegenerated
{
"success": true,
"results": [
{
"name": "example",
"ok": true,
"error": "example"
}
]
}

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"
}