Skip to content

Set box PIN

PUT
/v1/ns/{nsid}/vm/boxes/{context}/{box}/pin
curl --request PUT \
--url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vm/boxes/example/example/pin \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "pin": "example" }'
nsid
required
string format: uuid

Namespace UUID

context
required
string
box
required
string
Media typeapplication/json
object
pin
required
string
Examplegenerated
{
"pin": "example"
}

OK

Media typeapplication/json
object
success
required
boolean
Example
{
"success": true
}

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