Sessions API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• DELETE /sessions — Delete all sessions
• GET /sessions — Retrieve sessions
• POST /sessions — Create a session
• DELETE /sessions/{id} — Delete a session
• PUT /sessions/{id} — Update a session
• POST /sessions/{id}/lock — Lock a session

Delete all sessions

DELETE /api/sessions

Delete all sessions for the user. This will not delete the current session.

Authentication: API key. Permission: session.delete.

Responses

{
  "204": {
    "description": ""
  }
}

Retrieve sessions

GET /api/sessions

Retrieve a list of sessions for the user.

Authentication: API key. Permission: session.read.

Responses

Field definitions: SessionResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/SessionResponseDto"
          },
          "type": "array"
        }
      }
    },
    "description": ""
  }
}

Create a session

POST /api/sessions

Create a session as a child to the current session. This endpoint is used for casting.

Authentication: API key. Permission: session.create.

Request body

Required.

Field definitions: SessionCreateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/SessionCreateDto"
    }
  }
}

Responses

Field definitions: SessionCreateResponseDto

{
  "201": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SessionCreateResponseDto"
        }
      }
    },
    "description": ""
  }
}

Delete a session

DELETE /api/sessions/{id}

Delete a specific session by id.

Authentication: API key. Permission: session.delete.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

{
  "204": {
    "description": ""
  }
}

Update a session

PUT /api/sessions/{id}

Update a specific session identified by id.

Deprecated. Avoid this operation in new integrations; use the replacement supported by your server release.

Authentication: API key. Permission: session.update.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Request body

Required.

Field definitions: SessionUpdateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/SessionUpdateDto"
    }
  }
}

Responses

Field definitions: SessionResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SessionResponseDto"
        }
      }
    },
    "description": ""
  }
}

Lock a session

POST /api/sessions/{id}/lock

Lock a specific session by id.

Authentication: API key. Permission: session.lock.

Parameters

Name	Where	Required	Description
id	path	Yes	string

Parameter types, defaults and constraints

[
  {
    "name": "id",
    "required": true,
    "in": "path",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

{
  "204": {
    "description": ""
  }
}