ReferenceAPI
Suspend the current host connection if its sessions have drained
POST
/v1/hosts/{host_id}/suspendAuthorization
hostToken AuthorizationBearer <token>
The scoped token returned by POST /v1/hosts, sent as Authorization: Bearer . Identifies this registered host; do not substitute the server API token.
In: header
Path Parameters
host_id*string
Match
^host_[A-Za-z0-9]{20,32}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/hosts/string/suspend" \ -H "Authorization: Bearer YOUR_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "connection": 1 }'{ "suspended": true}