Viewer Shutdown

Disconnects a specific viewer session.

Request

Request

bash

curl -X DELETE "{BASE_URL}/api/viewers/{viewerId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Parameter	Type	Required	Description
`viewerId`	string	Yes	Unique identifier of the viewer session

Request With Parameters

bash

curl -X DELETE "{BASE_URL}/api/viewers/{viewerId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Parameter	Type	Description
`message`	string	Response status message
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "meta": {
    "executionTime": 5,
    "generatedAt": 1771940077110
  },
  "message": "Viewer has been disconnected"
}

Parameter	Type	Description
`message`	string	Human-readable error message

Viewer Not Found (404)

json

{
  "message": "Connection not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.