PorticoDocs

Admin Playback Sessions

Generated admin playback sessions operations.

GET/v1/admin/playback-sessionsRead server playback sessionsplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
get_admin_playback_sessions

Parameters

NameInTypeDescription
cursorquerystring
limitqueryinteger1–40
statusquerystring

Responses

200Successapplication/json

Example
{
  "items": [
    {
      "actions": [
        "string"
      ],
      "authorizationStopped": true,
      "cleanupStatus": "string",
      "createdAt": "2026-10-18T19:30:00Z",
      "delivery": "string",
      "expiresAt": "2026-10-18T19:30:00Z",
      "generation": 0,
      "itemId": "id_8h2k4q",
      "libraryId": "id_8h2k4q",
      "libraryKind": "string",
      "libraryName": "Fargo",
      "positionMs": 1800000,
      "reportedAt": "2026-10-18T19:30:00Z",
      "sessionId": "id_8h2k4q",
      "state": "string",
      "title": "Fargo"
    }
  ],
  "nextCursor": "eyJvIjoyMH0",
  "observedAt": "2026-10-18T19:30:00Z",
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  },
  "status": "string"
}
Schema
  • itemsarray of objectrequired
    • actionsarray of stringrequired
    • authorizationStoppedbooleanrequired
    • cleanupStatusstringrequired
    • createdAtstring | any | nullrequired
    • deliverystringrequired
    • expiresAtstringrequired
    • generationintegerrequired
    • itemIdstringrequired
    • libraryIdstringrequired
    • libraryKindstringrequired
    • libraryNamestringrequired
    • positionMsinteger | any | nullrequired
    • reportedAtstring | any | nullrequired
    • sessionIdstringrequired
    • statestringrequired
    • titlestringrequired
  • nextCursorstringrequired
  • observedAtstringrequired
  • scopeobjectrequired
    • serverIdstringrequired
    • viewerFencestringrequired
  • statusstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/playback-sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
POST/v1/admin/playback-sessions/{id}/stopRun server playback sessions stopplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
post_admin_playback_sessions_id_stop
Max body
64 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "expectedGeneration": 0,
  "operationId": "id_8h2k4q"
}
Schema
  • expectedGenerationintegerrequired
  • operationIdstringrequired

Responses

200Successapplication/json

Example
{
  "authorizationStopped": true,
  "cleanupStatus": "string",
  "generation": 0,
  "operationId": "id_8h2k4q",
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  },
  "sessionId": "id_8h2k4q",
  "state": "string"
}
Schema
  • authorizationStoppedbooleanrequired
  • cleanupStatusstringrequired
  • generationintegerrequired
  • operationIdstringrequired
  • scopeobjectrequired
    • serverIdstringrequired
    • viewerFencestringrequired
  • sessionIdstringrequired
  • statestringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/playback-sessions/{id}/stop" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedGeneration":0,"operationId":"id_8h2k4q"}'