CustomDomain™ docs
Cloud browser

End the session and release the browser

End the session and release the browser: CustomDomain™ API reference in the cloud browser group. Covers parameters, request body, responses and error codes.

POST
/browser-sessions/{sid}:cancel

Idempotent: a session that is already over answers its own state. During applying it stops at the next change boundary, never inside a change. A navigator.sendBeacon cannot set headers, so this route (and :event) also accepts the token in the body, as {"token": "..."} with a content type of text/plain or JSON.

Authorization

browserSession
AuthorizationBearer <token>

The session token of one cloud browser sign in, returned by POST /browser-sessions:redeem. It binds one session, one connection and one workspace, lives at most as long as the session, and stops working the moment the session ends. It lives in the popup's memory only.

In: header

Path Parameters

sid*string

The cloud browser session id, bs_ and 32 hex characters.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/browser-sessions/string:cancel" \  -H "Content-Type: application/json" \  -d '{}'
{  "state": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}