Admin Sessions

Generated admin sessions operations.

GET/v1/admin/sessionsActive playback sessions: who, what, how it's delivered and from whereadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: list_admin_sessions

Parameters

Name	In	Type	Description
`limit`	query	`integer \| ""`0–200
`cursor`	query	`string`

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "address": "string",
      "app": "string",
      "bandwidthKbps": 0,
      "bitrateKbps": 0,
      "bufferingSince": "string",
      "channel": {
        "name": "Fargo",
        "number": "string"
      },
      "currentBitrateKbps": 0,
      "decision": {
        "audio": {
          "action": "string",
          "channels": 0,
          "reasons": [],
          "to": "string"
        },
        "subtitles": {
          "action": "string",
          "channels": 0,
          "reasons": [],
          "to": "string"
        },
        "video": {
          "action": "string",
          "channels": 0,
          "reasons": [],
          "to": "string"
        }
      },
      "delivery": {
        "audioBitrateBps": 0,
        "audioChannels": 0,
        "hardware": {
          "backend": "string",
          "execution": {},
          "stages": []
        },
        "streams": [
          {}
        ],
        "videoBitrateBps": 0,
        "videoHeight": 0
      },
      "device": {
        "id": "id_8h2k4q",
        "name": "Fargo"
      },
      "durationMs": 1800000,
      "engine": "string",
      "id": "id_8h2k4q",
      "item": {
        "airDate": "string",
        "album": "string",
        "art": [
          {}
        ],
        "artist": "string",
        "author": "string",
        "bookTitle": "Fargo",
        "episodeNumber": 0,
        "episodeNumbering": "string",
        "id": "id_8h2k4q",
        "kind": "string",
        "seasonNumber": 0,
        "showId": "id_8h2k4q",
        "showTitle": "Fargo",
        "title": "Fargo",
        "year": 0
      },
      "kind": "string",
      "live": true,
      "location": "string",
      "media": {
        "audio": {
          "atmos": true,
          "bitDepth": 0,
          "channels": 0,
          "codec": "string",
          "commentary": true,
          "default": true,
          "dtsx": true,
          "id": "id_8h2k4q",
          "language": "en",
          "layout": "string",
          "objectAudio": "string",
          "profile": "string",
          "sampleRate": 0,
          "title": "Fargo",
          "variant": "string",
          "visualImpaired": true
        },
        "subtitles": {
          "format": "2026-10-18T19:30:00Z",
          "id": "id_8h2k4q",
          "language": "en"
        },
        "video": {
          "bitDepth": 0,
          "bitrateKbps": 0,
          "chromaSubsampling": "string",
          "codec": "string",
          "dolbyVisionBaseLayer": true,
          "dolbyVisionCmVersion": "string",
          "dolbyVisionCompatibility": 0,
          "dolbyVisionEnhancementType": "string",
          "dolbyVisionProfile": 0,
          "dolbyVisionRpu": true,
          "fps": 0,
          "frameRateDenominator": 0,
          "frameRateMode": "string",
          "frameRateNumerator": 0,
          "hdr": "string",
          "hdr10Plus": true,
          "height": 0,
          "id": "id_8h2k4q",
          "interlaced": true,
          "level": 0,
          "masterDisplay": "string",
          "maxCll": "string",
          "profile": "string",
          "width": 0
        },
        "videoHardware": true
      },
      "platform": "string",
      "positionMs": 1800000,
      "problem": "string",
      "profile": {
        "id": "id_8h2k4q",
        "name": "Fargo"
      },
      "programme": {
        "endsAt": "2026-10-18T19:30:00Z",
        "title": "Fargo"
      },
      "protocol": "string",
      "quality": {
        "id": "id_8h2k4q",
        "maxAudioBitrateKbps": 0,
        "maxHeight": 0,
        "maxVideoBitrateKbps": 0,
        "mode": "string",
        "step": "string"
      },
      "rateWindowMs": 1800000,
      "startedAt": "2026-10-18T19:30:00Z",
      "state": "string",
      "transcode": {
        "cadenceMs": 1800000,
        "observedAt": "2026-10-18T19:30:00Z",
        "speed": 0
      },
      "user": {
        "id": "id_8h2k4q",
        "name": "Fargo"
      },
      "videoHeight": 0
    }
  ],
  "observedAt": "2026-10-18T19:30:00Z",
  "page": {
    "limit": 0,
    "nextCursor": "eyJvIjoyMH0",
    "revision": "r12",
    "start": 0,
    "total": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  },
  "totals": {
    "atHome": 0,
    "away": 0,
    "bandwidthKbps": 0,
    "converting": 0,
    "paused": 0,
    "people": 0,
    "streams": 1800000
  }
}

Schema

itemsarray of objectrequired
- addressstring
- appstring
- bandwidthKbpsinteger
- bitrateKbpsinteger
- bufferingSincestring
- channelobject
  - namestringrequired
  - numberstring
- currentBitrateKbpsnumber | any | nullrequired
- decisionobjectrequired
  - audioobject
    actionstringrequired
    channelsinteger
    reasonsarray of stringrequired
    tostring
  - subtitlesobject
    actionstringrequired
    channelsinteger
    reasonsarray of stringrequired
    tostring
  - videoobject
    actionstringrequired
    channelsinteger
    reasonsarray of stringrequired
    tostring
- deliveryobject
  - audioBitrateBpsinteger
  - audioChannelsinteger
  - hardwareobject
    backendstringrequired
    executionobject
    fallbackCountintegerrequired
    lastLaunchobjectrequired
    decoderobjectrequired
    executionstringrequired
    namestringrequired
    encoderobjectrequired
    executionstringrequired
    namestringrequired
    generationintegerrequired
    renderNodestring
    sequenceintegerrequired
    startedAtstringrequired
    launchCountintegerrequired
    softwareLaunchCountintegerrequired
    unknownLaunchCountintegerrequired
    stagesarray of objectrequired
    executionstringrequired
    operationstringrequired
  - streamsarray of objectrequired
    actionstringrequired
    inputCodecstringrequired
    kindstringrequired
    outputCodecstringrequired
  - videoBitrateBpsinteger
  - videoHeightinteger
- deviceobjectrequired
  - idstringrequired
  - namestringrequired
- durationMsinteger
- enginestring
- idstringrequired
- itemobject
  - airDatestring
  - albumstring
  - artarray of objectrequired
    idstringrequired
    kindstringrequired
    revisionstringrequired
    rolestringrequired
  - artiststring
  - authorstring
  - bookTitlestring
  - episodeNumberinteger
  - episodeNumberingstring
  - idstringrequired
  - kindstringrequired
  - seasonNumberinteger
  - showIdstring
  - showTitlestring
  - titlestringrequired
  - yearinteger
- kindstringrequired
- livebooleanrequired
- locationstringrequired
- mediaobject
  - audioobject
    atmosbooleanrequired
    bitDepthinteger
    channelsinteger
    codecstringrequired
    commentarybooleanrequired
    defaultbooleanrequired
    dtsxbooleanrequired
    idstringrequired
    languagestring
    layoutstring
    objectAudiostring
    profilestring
    sampleRateinteger
    titlestring
    variantstring
    visualImpairedbooleanrequired
  - subtitlesobject
    formatstringrequired
    idstringrequired
    languagestring
  - videoobject
    bitDepthinteger
    bitrateKbpsinteger
    chromaSubsamplingstring
    codecstringrequired
    dolbyVisionBaseLayerbooleanrequired
    dolbyVisionCmVersionstring
    dolbyVisionCompatibilityinteger
    dolbyVisionEnhancementTypestring
    dolbyVisionProfileinteger
    dolbyVisionRpubooleanrequired
    fpsnumber
    frameRateDenominatorinteger
    frameRateModestring
    frameRateNumeratorinteger
    hdrstring
    hdr10Plusbooleanrequired
    heightinteger
    idstringrequired
    interlacedboolean
    levelinteger
    masterDisplaystring
    maxCllstring
    profilestring
    widthinteger
  - videoHardwareboolean
- platformstring
- positionMsintegerrequired
- problemstring
- profileobjectrequired
  - idstringrequired
  - namestringrequired
- programmeobject
  - endsAtstringrequired
  - titlestringrequired
- protocolstringrequired
- qualityobject
  - idstring
  - maxAudioBitrateKbpsinteger
  - maxHeightinteger
  - maxVideoBitrateKbpsinteger
  - modestringrequired
  - stepstring
- rateWindowMsintegerrequired
- startedAtstringrequired
- statestringrequired
- transcodeobject
  - cadenceMsintegerrequired
  - observedAtstringrequired
  - speednumberrequired
- userobjectrequired
  - idstringrequired
  - namestringrequired
- videoHeightinteger
observedAtstringrequired
pageobjectrequired
- limitintegerrequired
- nextCursorstring
- revisionstringrequired
- startintegerrequired
- totalintegerrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired
totalsobjectrequired
- atHomeintegerrequired
- awayintegerrequired
- bandwidthKbpsintegerrequired
- convertingintegerrequired
- pausedintegerrequired
- peopleintegerrequired
- streamsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedtimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/sessions" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/sessions/{id}:terminateEnd a viewer's playback, showing them an optional message; idempotentadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: terminate_admin_session
Max body: 4 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json

Example

{
  "message": "string"
}

Schema

messagestring

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundtimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sessions/{id}:terminate" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"string"}'

GET/v1/admin/sessions/{id}/controlsRead the transport controls and current revision of any administrable sessionadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_admin_session_controls

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "actions": [
    "string"
  ],
  "durationMs": 1800000,
  "generation": 0,
  "positionMs": 1800000,
  "revision": "r12",
  "sessionId": "id_8h2k4q",
  "state": "string"
}

Schema

actionsarray of stringrequired
durationMsinteger
generationintegerrequired
positionMsintegerrequired
revisionstringrequired
sessionIdstringrequired
statestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestrevision_requiredrevision_mismatchsession_endedinternaltimeoutdatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/sessions/{id}/controls" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/sessions/{id}/controlsPause, resume or seek any administrable session using its current revisionadmin

Audience: Integrations · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: control_admin_session
Max body: 4 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "action": "string",
  "expectedRevision": "r12",
  "positionMs": 1800000
}

Schema

actionstringrequired
expectedRevisionstringrequired
positionMsinteger

Responses

200Successapplication/json

Example

{
  "actions": [
    "string"
  ],
  "durationMs": 1800000,
  "generation": 0,
  "positionMs": 1800000,
  "revision": "r12",
  "sessionId": "id_8h2k4q",
  "state": "string"
}

Schema

actionsarray of stringrequired
durationMsinteger
generationintegerrequired
positionMsintegerrequired
revisionstringrequired
sessionIdstringrequired
statestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestrevision_requiredrevision_mismatchsession_endedinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sessions/{id}/controls" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"string","expectedRevision":"r12","positionMs":1800000}'