Issue WebSocket ticket

Issues a short-lived ticket for authenticating WebSocket connections. The ticket can be used as a query parameter when upgrading to WebSocket.

POST /api/session/ws-ticket

Error

A valid request URL is required to generate request examples

200

{
  "ticket": "<string>"
}

Authorizations

ManagementBearerAuthSessionCookieAuth

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Response

200

application/json

Ticket issued successfully

ticket · string

Short-lived WebSocket authentication ticket