a13nDocs
API referenceEnvironments

Open Desktop Viewer

POST/api/v1/environments/{environment_id}/desktop-viewer

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

environment_id*Environment Id

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/environments/string/desktop-viewer" \  -H "Content-Type: application/json" \  -d '{}'
{  "episode": 0,  "expires_at": "2019-08-24T14:15:22Z",  "generation": 0,  "mode": "view",  "password": "string",  "viewer_id": "string",  "websocket_url": "string"}