Admin Live

Generated admin live operations.

GET/v1/admin/live/settingsManage live source acquisition and guide settingsadmin

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "digest": "string",
    "revision": 0,
    "scope": "string",
    "settings": {
      "discoveryEnabled": true,
      "guideDays": 0,
      "importLimits": {
        "bytes": 0,
        "channels": 0,
        "programmes": 0
      },
      "logoImport": true,
      "retryWindowMs": 1800000,
      "streamBufferMs": 1800000,
      "timeshiftMinutes": 0,
      "userAgent": "string"
    }
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- digeststringrequired
- revisionintegerrequired
- scopestringrequired
- settingsobjectrequired
  - discoveryEnabledbooleanrequired
  - guideDaysintegerrequired
  - importLimitsobjectrequired
    bytesintegerrequired
    channelsintegerrequired
    programmesintegerrequired
  - logoImportbooleanrequired
  - retryWindowMsintegerrequired
  - streamBufferMsintegerrequired
  - timeshiftMinutesinteger
  - userAgentstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinvalid_channel_inputchannel_revision_conflictchannel_unavailablesource_lan_confirmation_requiredsource_network_policysource_credentials_requiredsource_unavailableinternaldatabase_busy

Example request

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

PUT/v1/admin/live/settingsManage live source acquisition and guide settingsadmin

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

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	`string`
`Portico-Mutation-Root`	header	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "operationId": "id_8h2k4q",
  "settings": {
    "discoveryEnabled": true,
    "guideDays": 0,
    "importLimits": {
      "bytes": 0,
      "channels": 0,
      "programmes": 0
    },
    "logoImport": true,
    "retryWindowMs": 1800000,
    "streamBufferMs": 1800000,
    "timeshiftMinutes": 0,
    "userAgent": "string"
  }
}

Schema

expectedRevisionintegerrequired
operationIdstringrequired
settingsobjectrequired
- discoveryEnabledbooleanrequired
- guideDaysintegerrequired
- importLimitsobjectrequired
  - bytesintegerrequired
  - channelsintegerrequired
  - programmesintegerrequired
- logoImportbooleanrequired
- retryWindowMsintegerrequired
- streamBufferMsintegerrequired
- timeshiftMinutesinteger
- userAgentstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "digest": "string",
    "revision": 0,
    "scope": "string",
    "settings": {
      "discoveryEnabled": true,
      "guideDays": 0,
      "importLimits": {
        "bytes": 0,
        "channels": 0,
        "programmes": 0
      },
      "logoImport": true,
      "retryWindowMs": 1800000,
      "streamBufferMs": 1800000,
      "timeshiftMinutes": 0,
      "userAgent": "string"
    }
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- digeststringrequired
- revisionintegerrequired
- scopestringrequired
- settingsobjectrequired
  - discoveryEnabledbooleanrequired
  - guideDaysintegerrequired
  - importLimitsobjectrequired
    bytesintegerrequired
    channelsintegerrequired
    programmesintegerrequired
  - logoImportbooleanrequired
  - retryWindowMsintegerrequired
  - streamBufferMsintegerrequired
  - timeshiftMinutesinteger
  - userAgentstringrequired
serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Example request

curl -X PUT "http://127.0.0.1:32500/v1/admin/live/settings" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedRevision": 0,
  "operationId": "id_8h2k4q",
  "settings": {
    "discoveryEnabled": true,
    "guideDays": 0,
    "importLimits": {
      "bytes": 0,
      "channels": 0,
      "programmes": 0
    },
    "logoImport": true,
    "retryWindowMs": 1800000,
    "streamBufferMs": 1800000,
    "timeshiftMinutes": 0,
    "userAgent": "string"
  }
}'

GET/v1/admin/live/sources/{id}/channelsList source choices, including groups and channels excluded from the line-upadmin

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

Parameters

Name	In	Type
`id`required	path	`string`
`cursor`	query	`string`
`limit`	query	`integer \| ""`0–200
`q`	query	`string`

Responses

200Successapplication/json

Example

{
  "generation": "string",
  "items": [
    {
      "channels": 0,
      "group": "string",
      "id": "id_8h2k4q",
      "name": "Fargo"
    }
  ],
  "kind": "string",
  "nextCursor": "eyJvIjoyMH0",
  "sourceId": "id_8h2k4q",
  "total": 0
}

Schema

generationstringrequired
itemsarray of objectrequired
- channelsintegerrequired
- groupstringrequired
- idstringrequired
- namestringrequired
kindstringrequired
nextCursorstringrequired
sourceIdstringrequired
totalintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinvalid_cursorrevision_mismatchadministration_unavailableinternaltimeoutdatabase_busy

Example request

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

GET/v1/admin/live/sources/{id}/groupsList source choices, including groups and channels excluded from the line-upadmin

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

Parameters

Name	In	Type
`id`required	path	`string`
`cursor`	query	`string`
`limit`	query	`integer \| ""`0–200
`q`	query	`string`

Responses

200Successapplication/json

Example

{
  "generation": "string",
  "items": [
    {
      "channels": 0,
      "group": "string",
      "id": "id_8h2k4q",
      "name": "Fargo"
    }
  ],
  "kind": "string",
  "nextCursor": "eyJvIjoyMH0",
  "sourceId": "id_8h2k4q",
  "total": 0
}

Schema

generationstringrequired
itemsarray of objectrequired
- channelsintegerrequired
- groupstringrequired
- idstringrequired
- namestringrequired
kindstringrequired
nextCursorstringrequired
sourceIdstringrequired
totalintegerrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittednot_foundinvalid_requestinvalid_cursorrevision_mismatchadministration_unavailableinternaltimeoutdatabase_busy

Example request

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