Cloud browser

End the session and release the browser

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 only this one) also accepts the token in the body, as {"token": "..."} with a content type of text/plain or JSON.

post/browser-sessions/{sid}:cancel

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/browser-sessions/{sid}:cancel
  • Auth: one of:
    • HTTP bearer
    • none

Path parameters

sidstring required

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

Request body

tokenstring

The session token, when it cannot be sent as a header.

Response

The state the session is in.

statestring

Changes

No recorded changes to this operation across all 1 revision of this API.