Admin Playback

Generated admin playback operations.

GET/v1/admin/playback/diagnosticsRead server playback diagnosticsadmin

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

Responses

200Successapplication/json

Example

{
  "diagnostics": {
    "activeConversionSessions": 0,
    "conversionLimitSource": "string",
    "conversionSessionLimit": 0,
    "conversionsRefused": 0,
    "directConfigured": true,
    "finiteHlsConfigured": true,
    "fragmentedOutput": true,
    "hardware": {
      "configured": "string",
      "device": "string",
      "devices": [
        {
          "id": "id_8h2k4q",
          "inUse": true,
          "method": "string",
          "name": "Fargo"
        }
      ],
      "effective": "string",
      "formats": [
        {
          "decode": true,
          "encode": true,
          "format": "2026-10-18T19:30:00Z"
        }
      ],
      "lastError": {
        "backend": "string",
        "detail": "string",
        "device": "string",
        "reason": "string"
      },
      "lastTest": 0,
      "probes": [
        {
          "backend": "string",
          "detail": "string",
          "device": "string",
          "encoder": "string",
          "supported": true
        }
      ]
    },
    "hardwareFallbacks": 0,
    "hlsConfigured": true,
    "hostConversionCapacity": 0,
    "lifecycle": "string",
    "memoryPlacementsRefused": 0,
    "memorySpills": 0,
    "outputPolicy": "string",
    "recentFailures": [
      {
        "code": "string",
        "diagnostic": "string",
        "hardwareBackend": "string",
        "sessionId": "id_8h2k4q",
        "sourceAudioCodec": "string",
        "sourceVideoCodec": "string",
        "strategy": "string"
      }
    ],
    "sessions": {
      "active": 0,
      "background": 0,
      "hardware": 0,
      "limits": {
        "background": 0,
        "concurrent": 0,
        "hardware": 0,
        "software": 0
      },
      "software": 0
    },
    "throughput": {
      "convertedSecondsPerSecond": 0,
      "detail": "string"
    }
  },
  "freshUntil": "string",
  "observedAt": "2026-10-18T19:30:00Z",
  "scope": {
    "key": "string"
  }
}

Schema

diagnosticsobjectrequired
- activeConversionSessionsinteger | any | nullrequired
- conversionLimitSourcestringrequired
- conversionSessionLimitinteger | any | nullrequired
- conversionsRefusedintegerrequired
- directConfiguredbooleanrequired
- finiteHlsConfiguredbooleanrequired
- fragmentedOutputbooleanrequired
- hardwareobjectrequired
  - configuredstringrequired
  - devicestringrequired
  - devicesarray of objectrequired
    idstringrequired
    inUsebooleanrequired
    methodstring
    namestringrequired
  - effectivestringrequired
  - formatsarray of objectrequired
    decodebooleanrequired
    encodebooleanrequired
    formatstringrequired
  - lastErrorobject | any | nullrequired
    backendstring
    detailstring
    devicestring
    reasonstringrequired
  - lastTestintegerrequired
  - probesarray of objectrequired
    backendstringrequired
    detailstringrequired
    devicestring
    encoderstring
    supportedbooleanrequired
- hardwareFallbacksintegerrequired
- hlsConfiguredbooleanrequired
- hostConversionCapacityintegerrequired
- lifecyclestringrequired
- memoryPlacementsRefusedintegerrequired
- memorySpillsintegerrequired
- outputPolicystringrequired
- recentFailuresarray of objectrequired
  - codestringrequired
  - diagnosticstringrequired
  - hardwareBackendstring
  - sessionIdstringrequired
  - sourceAudioCodecstring
  - sourceVideoCodecstring
  - strategystring
- sessionsobjectrequired
  - activeinteger | any | nullrequired
  - backgroundinteger | any | nullrequired
  - hardwareinteger | any | nullrequired
  - limitsobjectrequired
    backgroundintegerrequired
    concurrentintegerrequired
    hardwareintegerrequired
    softwareintegerrequired
  - softwareinteger | any | nullrequired
- throughputobjectrequired
  - convertedSecondsPerSecondnumber | any | nullrequired
  - detailstring
freshUntilstringrequired
observedAtstringrequired
scopeobjectrequired

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/diagnostics" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/playback/hardwareRead this server's hardware platform, its one remedy when no GPU is usable, and the V1 hardware target matrixadmin

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

Responses

200Successapplication/json

Example

{
  "formats": [
    {
      "id": "id_8h2k4q",
      "label": "string"
    }
  ],
  "later": [
    {
      "detail": "string",
      "id": "id_8h2k4q",
      "label": "string"
    }
  ],
  "platform": {
    "container": true,
    "kind": "string",
    "label": "string",
    "remedy": "string"
  },
  "targets": [
    {
      "decode": [
        "string"
      ],
      "encode": [
        "string"
      ],
      "id": "id_8h2k4q",
      "label": "string",
      "notes": [
        "string"
      ],
      "toneMapping": [
        "string"
      ]
    }
  ]
}

Schema

formatsarray of objectrequired
- idstringrequired
- labelstringrequired
laterarray of objectrequired
- detailstringrequired
- idstringrequired
- labelstringrequired
platformobjectrequired
- containerbooleanrequired
- kindstringrequired
- labelstringrequired
- remedystring
targetsarray of objectrequired
- decodearray of stringrequired
- encodearray of stringrequired
- idstringrequired
- labelstringrequired
- notesarray of stringrequired
- toneMappingarray of stringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedtimeoutdatabase_busy

Example request

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

GET/v1/admin/playback/historyRead or update the selected projectionadmin

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

Parameters

Name	In	Type
`period`	query	`string`
`limit`	query	`integer \| ""`1–200
`cursor`	query	`string`

Responses

200Successapplication/json

Example

{
  "data": {
    "items": [
      {
        "accountId": "id_8h2k4q",
        "authority": "string",
        "deliveryMode": "string",
        "deliveryStrategy": "string",
        "durationMs": 1800000,
        "endedAt": "2026-10-18T19:30:00Z",
        "id": "id_8h2k4q",
        "itemId": "id_8h2k4q",
        "libraryName": "Fargo",
        "mediaKind": "string",
        "profileId": "id_8h2k4q",
        "qualityMode": "string",
        "startedAt": "2026-10-18T19:30:00Z",
        "state": "string",
        "title": "Fargo",
        "viewer": "string"
      }
    ],
    "nextCursor": "eyJvIjoyMH0"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

Schema

dataobjectrequired
- itemsarray of objectrequired
  - accountIdstringrequired
  - authoritystringrequired
  - deliveryModestringrequired
  - deliveryStrategystringrequired
  - durationMsinteger | any | nullrequired
  - endedAtstring | any | nullrequired
  - idstringrequired
  - itemIdstringrequired
  - libraryNamestringrequired
  - mediaKindstringrequired
  - profileIdstringrequired
  - qualityModestringrequired
  - startedAtstringrequired
    RFC 3339 UTC instant; empty when absent.
  - statestringrequired
  - titlestringrequired
  - viewerstringrequired
- nextCursorstringrequired
scopeobjectrequired
- serverIdstringrequired
- viewerFencestringrequired

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/history" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/playback/history.csvRead server playback history.csvadmin

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

Responses

200Successtext/csv

Example

"string"

Schema

string (binary)

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/history.csv" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/playback/route-failuresRead active remembered playback failuresadmin

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

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "code": "string",
      "detail": "string",
      "engine": "string",
      "expiresAtMs": 1800000,
      "itemId": "id_8h2k4q",
      "kind": "string",
      "reportedAtMs": 1800000,
      "route": "string",
      "sourceId": "id_8h2k4q",
      "title": "Fargo"
    }
  ],
  "more": true
}

Schema

itemsarray of objectrequired
- codestringrequired
- detailstringrequired
- enginestringrequired
- expiresAtMsintegerrequired
- itemIdstring
- kindstring
- reportedAtMsintegerrequired
- routestringrequired
- sourceIdstringrequired
- titlestring
morebooleanrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinternaltimeoutdatabase_busy

Example request

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

DELETE/v1/admin/playback/route-failures/{sourceId}Forget remembered failures for a media fileadmin

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

Parameters

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

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestinternaltimeoutdatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/admin/playback/route-failures/{sourceId}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"