Admin Library Channels

Generated admin library channels operations.

GET/v1/admin/library-channelsRead server library channelsadmin

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_library_channels

Responses

200Successapplication/json

Example

{
  "channels": [
    {
      "candidateCount": 0,
      "config": {
        "blocks": [
          {}
        ],
        "defaultRuleId": "id_8h2k4q",
        "description": "string",
        "enabled": true,
        "id": "id_8h2k4q",
        "logoItemId": "id_8h2k4q",
        "name": "Fargo",
        "overlay": {
          "corner": "string",
          "enabled": true,
          "insetPercent": 0,
          "sizePercent": 0,
          "treatment": "string"
        },
        "position": 0,
        "protocolVersion": "string",
        "quality": {
          "allowHdrToSdr": true,
          "allowLossy": true,
          "maxBitrate": 0,
          "maxHeight": 0,
          "mode": "string"
        },
        "rules": [
          {}
        ],
        "seed": "string",
        "templateId": "id_8h2k4q",
        "timezone": "2026-10-18T19:30:00Z",
        "viewerAccess": "string"
      },
      "generatedThrough": "string",
      "generation": "string",
      "healthCode": "string",
      "replacementBoundary": "string",
      "revision": 0,
      "state": "string",
      "unresolvedDurationCount": 0
    }
  ],
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

channelsarray of objectrequired
- candidateCountintegerrequired
- configobjectrequired
  - blocksarray of objectrequired
    anchorstringrequired
    endMinuteintegerrequired
    fallbackRuleIdstringrequired
    idstringrequired
    overrunstringrequired
    priorityintegerrequired
    ruleIdstringrequired
    startMinuteintegerrequired
    weekdaysarray of integerrequired
  - defaultRuleIdstringrequired
  - descriptionstringrequired
  - enabledbooleanrequired
  - idstringrequired
  - logoItemIdstringrequired
  - namestringrequired
  - overlayobjectrequired
    cornerstringrequired
    enabledbooleanrequired
    insetPercentintegerrequired
    sizePercentintegerrequired
    treatmentstringrequired
  - positionintegerrequired
  - protocolVersionstringrequired
  - qualityobjectrequired
    allowHdrToSdrbooleanrequired
    allowLossybooleanrequired
    maxBitrateintegerrequired
    maxHeightintegerrequired
    modestringrequired
  - rulesarray of objectrequired
    deduplicationWindowintegerrequired
    episodeModestringrequired
    exhaustionstringrequired
    idstringrequired
    maxConsecutiveintegerrequired
    modestringrequired
    namestringrequired
    queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
    weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
  - seedstringrequired
  - templateIdstringrequired
  - timezonestringrequired
  - viewerAccessstringrequired
- generatedThroughstringrequired
- generationstringrequired
- healthCodestringrequired
- replacementBoundarystringrequired
- revisionintegerrequired
- statestringrequired
- unresolvedDurationCountintegerrequired
protocolVersionstringrequired
serverIdstringrequired

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

POST/v1/admin/library-channelsRun server library channelsadmin

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

Request body application/json · required

Example

{
  "config": {
    "blocks": [
      {
        "anchor": "string",
        "endMinute": 0,
        "fallbackRuleId": "id_8h2k4q",
        "id": "id_8h2k4q",
        "overrun": "string",
        "priority": 0,
        "ruleId": "id_8h2k4q",
        "startMinute": 0,
        "weekdays": [
          0
        ]
      }
    ],
    "defaultRuleId": "id_8h2k4q",
    "description": "string",
    "enabled": true,
    "id": "id_8h2k4q",
    "logoItemId": "id_8h2k4q",
    "name": "Fargo",
    "overlay": {
      "corner": "string",
      "enabled": true,
      "insetPercent": 0,
      "sizePercent": 0,
      "treatment": "string"
    },
    "position": 0,
    "protocolVersion": "string",
    "quality": {
      "allowHdrToSdr": true,
      "allowLossy": true,
      "maxBitrate": 0,
      "maxHeight": 0,
      "mode": "string"
    },
    "rules": [
      {
        "deduplicationWindow": 0,
        "episodeMode": "string",
        "exhaustion": "string",
        "id": "id_8h2k4q",
        "maxConsecutive": 0,
        "mode": "string",
        "name": "Fargo",
        "query": {
          "excludeItemIds": [],
          "filter": null,
          "genres": [],
          "includeItemIds": [],
          "kinds": [],
          "libraryIds": [],
          "limit": 0,
          "order": "string",
          "recentDays": 0,
          "showIds": [],
          "text": "string",
          "yearFrom": 0,
          "yearThrough": 0
        },
        "weights": [
          {}
        ]
      }
    ],
    "seed": "string",
    "templateId": "id_8h2k4q",
    "timezone": "2026-10-18T19:30:00Z",
    "viewerAccess": "string"
  },
  "expectedRevision": 0,
  "requestId": "id_8h2k4q"
}

Schema

configobjectrequired
- blocksarray of objectrequired
  - anchorstringrequired
  - endMinuteintegerrequired
  - fallbackRuleIdstringrequired
  - idstringrequired
  - overrunstringrequired
  - priorityintegerrequired
  - ruleIdstringrequired
  - startMinuteintegerrequired
  - weekdaysarray of integerrequired
- defaultRuleIdstringrequired
- descriptionstringrequired
- enabledbooleanrequired
- idstringrequired
- logoItemIdstringrequired
- namestringrequired
- overlayobjectrequired
  - cornerstringrequired
  - enabledbooleanrequired
  - insetPercentintegerrequired
  - sizePercentintegerrequired
  - treatmentstringrequired
- positionintegerrequired
- protocolVersionstringrequired
- qualityobjectrequired
  - allowHdrToSdrbooleanrequired
  - allowLossybooleanrequired
  - maxBitrateintegerrequired
  - maxHeightintegerrequired
  - modestringrequired
- rulesarray of objectrequired
  - deduplicationWindowintegerrequired
  - episodeModestringrequired
  - exhaustionstringrequired
  - idstringrequired
  - maxConsecutiveintegerrequired
  - modestringrequired
  - namestringrequired
  - queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
  - weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
- seedstringrequired
- templateIdstringrequired
- timezonestringrequired
- viewerAccessstringrequired
expectedRevisionintegerrequired
requestIdstringrequired

Responses

200Successapplication/json

Example

{
  "channel": {
    "candidateCount": 0,
    "config": {
      "blocks": [
        {
          "anchor": "string",
          "endMinute": 0,
          "fallbackRuleId": "id_8h2k4q",
          "id": "id_8h2k4q",
          "overrun": "string",
          "priority": 0,
          "ruleId": "id_8h2k4q",
          "startMinute": 0,
          "weekdays": []
        }
      ],
      "defaultRuleId": "id_8h2k4q",
      "description": "string",
      "enabled": true,
      "id": "id_8h2k4q",
      "logoItemId": "id_8h2k4q",
      "name": "Fargo",
      "overlay": {
        "corner": "string",
        "enabled": true,
        "insetPercent": 0,
        "sizePercent": 0,
        "treatment": "string"
      },
      "position": 0,
      "protocolVersion": "string",
      "quality": {
        "allowHdrToSdr": true,
        "allowLossy": true,
        "maxBitrate": 0,
        "maxHeight": 0,
        "mode": "string"
      },
      "rules": [
        {
          "deduplicationWindow": 0,
          "episodeMode": "string",
          "exhaustion": "string",
          "id": "id_8h2k4q",
          "maxConsecutive": 0,
          "mode": "string",
          "name": "Fargo",
          "query": {},
          "weights": []
        }
      ],
      "seed": "string",
      "templateId": "id_8h2k4q",
      "timezone": "2026-10-18T19:30:00Z",
      "viewerAccess": "string"
    },
    "generatedThrough": "string",
    "generation": "string",
    "healthCode": "string",
    "replacementBoundary": "string",
    "revision": 0,
    "state": "string",
    "unresolvedDurationCount": 0
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

channelobjectrequired
- candidateCountintegerrequired
- configobjectrequired
  - blocksarray of objectrequired
    anchorstringrequired
    endMinuteintegerrequired
    fallbackRuleIdstringrequired
    idstringrequired
    overrunstringrequired
    priorityintegerrequired
    ruleIdstringrequired
    startMinuteintegerrequired
    weekdaysarray of integerrequired
  - defaultRuleIdstringrequired
  - descriptionstringrequired
  - enabledbooleanrequired
  - idstringrequired
  - logoItemIdstringrequired
  - namestringrequired
  - overlayobjectrequired
    cornerstringrequired
    enabledbooleanrequired
    insetPercentintegerrequired
    sizePercentintegerrequired
    treatmentstringrequired
  - positionintegerrequired
  - protocolVersionstringrequired
  - qualityobjectrequired
    allowHdrToSdrbooleanrequired
    allowLossybooleanrequired
    maxBitrateintegerrequired
    maxHeightintegerrequired
    modestringrequired
  - rulesarray of objectrequired
    deduplicationWindowintegerrequired
    episodeModestringrequired
    exhaustionstringrequired
    idstringrequired
    maxConsecutiveintegerrequired
    modestringrequired
    namestringrequired
    queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
    weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
  - seedstringrequired
  - templateIdstringrequired
  - timezonestringrequired
  - viewerAccessstringrequired
- generatedThroughstringrequired
- generationstringrequired
- healthCodestringrequired
- replacementBoundarystringrequired
- revisionintegerrequired
- statestringrequired
- unresolvedDurationCountintegerrequired
protocolVersionstringrequired
serverIdstringrequired

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/library-channels" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "config": {
    "blocks": [
      {
        "anchor": "string",
        "endMinute": 0,
        "fallbackRuleId": "id_8h2k4q",
        "id": "id_8h2k4q",
        "overrun": "string",
        "priority": 0,
        "ruleId": "id_8h2k4q",
        "startMinute": 0,
        "weekdays": [
          0
        ]
      }
    ],
    "defaultRuleId": "id_8h2k4q",
    "description": "string",
    "enabled": true,
    "id": "id_8h2k4q",
    "logoItemId": "id_8h2k4q",
    "name": "Fargo",
    "overlay": {
      "corner": "string",
      "enabled": true,
      "insetPercent": 0,
      "sizePercent": 0,
      "treatment": "string"
    },
    "position": 0,
    "protocolVersion": "string",
    "quality": {
      "allowHdrToSdr": true,
      "allowLossy": true,
      "maxBitrate": 0,
      "maxHeight": 0,
      "mode": "string"
    },
    "rules": [
      {
        "deduplicationWindow": 0,
        "episodeMode": "string",
        "exhaustion": "string",
        "id": "id_8h2k4q",
        "maxConsecutive": 0,
        "mode": "string",
        "name": "Fargo",
        "query": {
          "excludeItemIds": [],
          "filter": null,
          "genres": [],
          "includeItemIds": [],
          "kinds": [],
          "libraryIds": [],
          "limit": 0,
          "order": "string",
          "recentDays": 0,
          "showIds": [],
          "text": "string",
          "yearFrom": 0,
          "yearThrough": 0
        },
        "weights": [
          {}
        ]
      }
    ],
    "seed": "string",
    "templateId": "id_8h2k4q",
    "timezone": "2026-10-18T19:30:00Z",
    "viewerAccess": "string"
  },
  "expectedRevision": 0,
  "requestId": "id_8h2k4q"
}'

POST/v1/admin/library-channels/{id}/deleteRun server library channels deleteadmin

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

Parameters

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

Request body application/json · required

Example

{
  "expectedRevision": 0,
  "requestId": "id_8h2k4q"
}

Schema

expectedRevisionintegerrequired
requestIdstringrequired

Responses

200Successapplication/json

Example

{
  "deleted": true,
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

deletedbooleanrequired
protocolVersionstringrequired
serverIdstringrequired

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/library-channels/{id}/delete" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"requestId":"id_8h2k4q"}'

GET/v1/admin/library-channels/{id}/healthRead server library channels healthadmin

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_library_channels_id_health

Parameters

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "activeGeneration": "string",
    "candidates": 0,
    "channelId": "id_8h2k4q",
    "enabled": true,
    "generatedThrough": "string",
    "healthCode": "string",
    "healthy": true,
    "message": "string",
    "name": "Fargo",
    "observedAt": "2026-10-18T19:30:00Z",
    "pendingGeneration": true,
    "scheduledEntries": 0,
    "state": "string",
    "unresolved": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- activeGenerationstringrequired
- candidatesintegerrequired
- channelIdstringrequired
- enabledbooleanrequired
- generatedThroughstringrequired
- healthCodestringrequired
- healthybooleanrequired
- messagestringrequired
- namestringrequired
- observedAtstringrequired
- pendingGenerationbooleanrequired
- scheduledEntriesintegerrequired
- statestringrequired
- unresolvedintegerrequired
serverIdstringrequired

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/library-channels/{id}/health" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/library-channels/{id}/logoRun server library channels logoadmin

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

Parameters

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

Request body multipart/form-data · required

Example

{
  "expectedRevision": "r12",
  "file": "string",
  "operationId": "id_8h2k4q"
}

Schema

expectedRevisionstringrequired
filestring (binary)required
operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "bytes": 0,
    "channelId": "id_8h2k4q",
    "digest": "string",
    "height": 0,
    "mediaType": "string",
    "revision": 0,
    "updatedAt": "2026-10-18T19:30:00Z",
    "url": "https://example.com/…",
    "width": 0
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- bytesintegerrequired
- channelIdstringrequired
- digeststringrequired
- heightintegerrequired
- mediaTypestringrequired
- revisionintegerrequired
- updatedAtstringrequired
- urlstringrequired
- widthintegerrequired
serverIdstringrequired

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/library-channels/{id}/logo" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/library-channels/{id}/regenerateRun server library channels regenerateadmin

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

Parameters

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

Request body application/json · required

Example

{
  "boundary": "string",
  "expectedRevision": 0,
  "requestId": "id_8h2k4q"
}

Schema

boundarystringrequired
expectedRevisionintegerrequired
requestIdstringrequired

Responses

200Successapplication/json

Example

{
  "channel": {
    "candidateCount": 0,
    "config": {
      "blocks": [
        {
          "anchor": "string",
          "endMinute": 0,
          "fallbackRuleId": "id_8h2k4q",
          "id": "id_8h2k4q",
          "overrun": "string",
          "priority": 0,
          "ruleId": "id_8h2k4q",
          "startMinute": 0,
          "weekdays": []
        }
      ],
      "defaultRuleId": "id_8h2k4q",
      "description": "string",
      "enabled": true,
      "id": "id_8h2k4q",
      "logoItemId": "id_8h2k4q",
      "name": "Fargo",
      "overlay": {
        "corner": "string",
        "enabled": true,
        "insetPercent": 0,
        "sizePercent": 0,
        "treatment": "string"
      },
      "position": 0,
      "protocolVersion": "string",
      "quality": {
        "allowHdrToSdr": true,
        "allowLossy": true,
        "maxBitrate": 0,
        "maxHeight": 0,
        "mode": "string"
      },
      "rules": [
        {
          "deduplicationWindow": 0,
          "episodeMode": "string",
          "exhaustion": "string",
          "id": "id_8h2k4q",
          "maxConsecutive": 0,
          "mode": "string",
          "name": "Fargo",
          "query": {},
          "weights": []
        }
      ],
      "seed": "string",
      "templateId": "id_8h2k4q",
      "timezone": "2026-10-18T19:30:00Z",
      "viewerAccess": "string"
    },
    "generatedThrough": "string",
    "generation": "string",
    "healthCode": "string",
    "replacementBoundary": "string",
    "revision": 0,
    "state": "string",
    "unresolvedDurationCount": 0
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

channelobjectrequired
- candidateCountintegerrequired
- configobjectrequired
  - blocksarray of objectrequired
    anchorstringrequired
    endMinuteintegerrequired
    fallbackRuleIdstringrequired
    idstringrequired
    overrunstringrequired
    priorityintegerrequired
    ruleIdstringrequired
    startMinuteintegerrequired
    weekdaysarray of integerrequired
  - defaultRuleIdstringrequired
  - descriptionstringrequired
  - enabledbooleanrequired
  - idstringrequired
  - logoItemIdstringrequired
  - namestringrequired
  - overlayobjectrequired
    cornerstringrequired
    enabledbooleanrequired
    insetPercentintegerrequired
    sizePercentintegerrequired
    treatmentstringrequired
  - positionintegerrequired
  - protocolVersionstringrequired
  - qualityobjectrequired
    allowHdrToSdrbooleanrequired
    allowLossybooleanrequired
    maxBitrateintegerrequired
    maxHeightintegerrequired
    modestringrequired
  - rulesarray of objectrequired
    deduplicationWindowintegerrequired
    episodeModestringrequired
    exhaustionstringrequired
    idstringrequired
    maxConsecutiveintegerrequired
    modestringrequired
    namestringrequired
    queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
    weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
  - seedstringrequired
  - templateIdstringrequired
  - timezonestringrequired
  - viewerAccessstringrequired
- generatedThroughstringrequired
- generationstringrequired
- healthCodestringrequired
- replacementBoundarystringrequired
- revisionintegerrequired
- statestringrequired
- unresolvedDurationCountintegerrequired
protocolVersionstringrequired
serverIdstringrequired

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/library-channels/{id}/regenerate" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"boundary":"string","expectedRevision":0,"requestId":"id_8h2k4q"}'

GET/v1/admin/library-channels/block-presetsRead server library channels block presetsadmin

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_library_channels_block_presets

Parameters

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "enumerations": {
      "key": [
        "string"
      ]
    },
    "items": [
      {
        "body": {
          "criteria": [],
          "days": [],
          "description": "string",
          "durationMinutes": 0,
          "libraryId": "id_8h2k4q",
          "order": "string",
          "startMinute": 0
        },
        "createdAt": "2026-10-18T19:30:00Z",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "revision": 0,
        "updatedAt": "2026-10-18T19:30:00Z"
      }
    ],
    "nextCursor": "eyJvIjoyMH0"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- enumerationsobjectrequired
- itemsarray of objectrequired
  - bodyobjectrequired
    criteriaarray of objectrequired
    fieldstringrequired
    operatorstringrequired
    valuesarray of stringrequired
    daysarray of stringrequired
    descriptionstringrequired
    durationMinutesintegerrequired
    libraryIdstringrequired
    orderstringrequired
    startMinuteintegerrequired
  - createdAtstringrequired
  - idstringrequired
  - namestringrequired
  - revisionintegerrequired
  - updatedAtstringrequired
- nextCursorstringrequired
serverIdstringrequired

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/library-channels/block-presets" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/admin/library-channels/block-presetsRun server library channels block presetsadmin

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

Request body application/json · required

Example

{
  "body": {
    "criteria": [
      {
        "field": "string",
        "operator": "string",
        "values": [
          "string"
        ]
      }
    ],
    "days": [
      "string"
    ],
    "description": "string",
    "durationMinutes": 0,
    "libraryId": "id_8h2k4q",
    "order": "string",
    "startMinute": 0
  },
  "expectedRevision": 0,
  "name": "Fargo",
  "operationId": "id_8h2k4q"
}

Schema

bodyobjectrequired
- criteriaarray of objectrequired
  - fieldstringrequired
  - operatorstringrequired
  - valuesarray of stringrequired
- daysarray of stringrequired
- descriptionstringrequired
- durationMinutesintegerrequired
- libraryIdstringrequired
- orderstringrequired
- startMinuteintegerrequired
expectedRevisionintegerrequired
namestringrequired
operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "body": {
      "criteria": [
        {
          "field": "string",
          "operator": "string",
          "values": []
        }
      ],
      "days": [
        "string"
      ],
      "description": "string",
      "durationMinutes": 0,
      "libraryId": "id_8h2k4q",
      "order": "string",
      "startMinute": 0
    },
    "createdAt": "2026-10-18T19:30:00Z",
    "id": "id_8h2k4q",
    "name": "Fargo",
    "revision": 0,
    "updatedAt": "2026-10-18T19:30:00Z"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- bodyobjectrequired
  - criteriaarray of objectrequired
    fieldstringrequired
    operatorstringrequired
    valuesarray of stringrequired
  - daysarray of stringrequired
  - descriptionstringrequired
  - durationMinutesintegerrequired
  - libraryIdstringrequired
  - orderstringrequired
  - startMinuteintegerrequired
- createdAtstringrequired
- idstringrequired
- namestringrequired
- revisionintegerrequired
- updatedAtstringrequired
serverIdstringrequired

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/library-channels/block-presets" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": {
    "criteria": [
      {
        "field": "string",
        "operator": "string",
        "values": [
          "string"
        ]
      }
    ],
    "days": [
      "string"
    ],
    "description": "string",
    "durationMinutes": 0,
    "libraryId": "id_8h2k4q",
    "order": "string",
    "startMinute": 0
  },
  "expectedRevision": 0,
  "name": "Fargo",
  "operationId": "id_8h2k4q"
}'

DELETE/v1/admin/library-channels/block-presets/{id}Remove server library channels block presetsadmin

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

Parameters

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "deleted": true,
    "id": "id_8h2k4q"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- deletedbooleanrequired
- idstringrequired
serverIdstringrequired

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 DELETE "http://127.0.0.1:32500/v1/admin/library-channels/block-presets/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PUT/v1/admin/library-channels/block-presets/{id}Save server library channels block presetsadmin

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

Parameters

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

Request body application/json · required

Example

{
  "body": {
    "criteria": [
      {
        "field": "string",
        "operator": "string",
        "values": [
          "string"
        ]
      }
    ],
    "days": [
      "string"
    ],
    "description": "string",
    "durationMinutes": 0,
    "libraryId": "id_8h2k4q",
    "order": "string",
    "startMinute": 0
  },
  "expectedRevision": 0,
  "name": "Fargo",
  "operationId": "id_8h2k4q"
}

Schema

bodyobjectrequired
- criteriaarray of objectrequired
  - fieldstringrequired
  - operatorstringrequired
  - valuesarray of stringrequired
- daysarray of stringrequired
- descriptionstringrequired
- durationMinutesintegerrequired
- libraryIdstringrequired
- orderstringrequired
- startMinuteintegerrequired
expectedRevisionintegerrequired
namestringrequired
operationIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "body": {
      "criteria": [
        {
          "field": "string",
          "operator": "string",
          "values": []
        }
      ],
      "days": [
        "string"
      ],
      "description": "string",
      "durationMinutes": 0,
      "libraryId": "id_8h2k4q",
      "order": "string",
      "startMinute": 0
    },
    "createdAt": "2026-10-18T19:30:00Z",
    "id": "id_8h2k4q",
    "name": "Fargo",
    "revision": 0,
    "updatedAt": "2026-10-18T19:30:00Z"
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- bodyobjectrequired
  - criteriaarray of objectrequired
    fieldstringrequired
    operatorstringrequired
    valuesarray of stringrequired
  - daysarray of stringrequired
  - descriptionstringrequired
  - durationMinutesintegerrequired
  - libraryIdstringrequired
  - orderstringrequired
  - startMinuteintegerrequired
- createdAtstringrequired
- idstringrequired
- namestringrequired
- revisionintegerrequired
- updatedAtstringrequired
serverIdstringrequired

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 PUT "http://127.0.0.1:32500/v1/admin/library-channels/block-presets/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": {
    "criteria": [
      {
        "field": "string",
        "operator": "string",
        "values": [
          "string"
        ]
      }
    ],
    "days": [
      "string"
    ],
    "description": "string",
    "durationMinutes": 0,
    "libraryId": "id_8h2k4q",
    "order": "string",
    "startMinute": 0
  },
  "expectedRevision": 0,
  "name": "Fargo",
  "operationId": "id_8h2k4q"
}'

GET/v1/admin/library-channels/criteriaRead server library channels criteriaadmin

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_library_channels_criteria

Parameters

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

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "result": {
    "field": "string",
    "fields": [
      {
        "description": "string",
        "field": "string",
        "name": "Fargo",
        "valueCount": 0
      }
    ],
    "libraryId": "id_8h2k4q",
    "nextCursor": "eyJvIjoyMH0",
    "values": [
      {
        "itemCount": 0,
        "value": "string",
        "valueKey": "string"
      }
    ]
  },
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
resultobjectrequired
- fieldstringrequired
- fieldsarray of objectrequired
  - descriptionstringrequired
  - fieldstringrequired
  - namestringrequired
  - valueCountintegerrequired
- libraryIdstringrequired
- nextCursorstringrequired
- valuesarray of objectrequired
  - itemCountintegerrequired
  - valuestringrequired
  - valueKeystringrequired
serverIdstringrequired

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

POST/v1/admin/library-channels/defaultsRun server library channels defaultsadmin

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

Request body application/json · required

Example

{
  "timezone": "2026-10-18T19:30:00Z"
}

Schema

timezonestringrequired

Responses

200Successapplication/json

Example

{
  "config": {
    "blocks": [
      {
        "anchor": "string",
        "endMinute": 0,
        "fallbackRuleId": "id_8h2k4q",
        "id": "id_8h2k4q",
        "overrun": "string",
        "priority": 0,
        "ruleId": "id_8h2k4q",
        "startMinute": 0,
        "weekdays": [
          0
        ]
      }
    ],
    "defaultRuleId": "id_8h2k4q",
    "description": "string",
    "enabled": true,
    "id": "id_8h2k4q",
    "logoItemId": "id_8h2k4q",
    "name": "Fargo",
    "overlay": {
      "corner": "string",
      "enabled": true,
      "insetPercent": 0,
      "sizePercent": 0,
      "treatment": "string"
    },
    "position": 0,
    "protocolVersion": "string",
    "quality": {
      "allowHdrToSdr": true,
      "allowLossy": true,
      "maxBitrate": 0,
      "maxHeight": 0,
      "mode": "string"
    },
    "rules": [
      {
        "deduplicationWindow": 0,
        "episodeMode": "string",
        "exhaustion": "string",
        "id": "id_8h2k4q",
        "maxConsecutive": 0,
        "mode": "string",
        "name": "Fargo",
        "query": {
          "excludeItemIds": [],
          "filter": null,
          "genres": [],
          "includeItemIds": [],
          "kinds": [],
          "libraryIds": [],
          "limit": 0,
          "order": "string",
          "recentDays": 0,
          "showIds": [],
          "text": "string",
          "yearFrom": 0,
          "yearThrough": 0
        },
        "weights": [
          {}
        ]
      }
    ],
    "seed": "string",
    "templateId": "id_8h2k4q",
    "timezone": "2026-10-18T19:30:00Z",
    "viewerAccess": "string"
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

configobjectrequired
- blocksarray of objectrequired
  - anchorstringrequired
  - endMinuteintegerrequired
  - fallbackRuleIdstringrequired
  - idstringrequired
  - overrunstringrequired
  - priorityintegerrequired
  - ruleIdstringrequired
  - startMinuteintegerrequired
  - weekdaysarray of integerrequired
- defaultRuleIdstringrequired
- descriptionstringrequired
- enabledbooleanrequired
- idstringrequired
- logoItemIdstringrequired
- namestringrequired
- overlayobjectrequired
  - cornerstringrequired
  - enabledbooleanrequired
  - insetPercentintegerrequired
  - sizePercentintegerrequired
  - treatmentstringrequired
- positionintegerrequired
- protocolVersionstringrequired
- qualityobjectrequired
  - allowHdrToSdrbooleanrequired
  - allowLossybooleanrequired
  - maxBitrateintegerrequired
  - maxHeightintegerrequired
  - modestringrequired
- rulesarray of objectrequired
  - deduplicationWindowintegerrequired
  - episodeModestringrequired
  - exhaustionstringrequired
  - idstringrequired
  - maxConsecutiveintegerrequired
  - modestringrequired
  - namestringrequired
  - queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
  - weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
- seedstringrequired
- templateIdstringrequired
- timezonestringrequired
- viewerAccessstringrequired
protocolVersionstringrequired
serverIdstringrequired

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/library-channels/defaults" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"timezone":"2026-10-18T19:30:00Z"}'

POST/v1/admin/library-channels/previewRun server library channels previewadmin

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

Request body application/json · required

Example

{
  "blocks": [
    {
      "anchor": "string",
      "endMinute": 0,
      "fallbackRuleId": "id_8h2k4q",
      "id": "id_8h2k4q",
      "overrun": "string",
      "priority": 0,
      "ruleId": "id_8h2k4q",
      "startMinute": 0,
      "weekdays": [
        0
      ]
    }
  ],
  "defaultRuleId": "id_8h2k4q",
  "description": "string",
  "enabled": true,
  "id": "id_8h2k4q",
  "logoItemId": "id_8h2k4q",
  "name": "Fargo",
  "overlay": {
    "corner": "string",
    "enabled": true,
    "insetPercent": 0,
    "sizePercent": 0,
    "treatment": "string"
  },
  "position": 0,
  "protocolVersion": "string",
  "quality": {
    "allowHdrToSdr": true,
    "allowLossy": true,
    "maxBitrate": 0,
    "maxHeight": 0,
    "mode": "string"
  },
  "rules": [
    {
      "deduplicationWindow": 0,
      "episodeMode": "string",
      "exhaustion": "string",
      "id": "id_8h2k4q",
      "maxConsecutive": 0,
      "mode": "string",
      "name": "Fargo",
      "query": {
        "excludeItemIds": [
          "string"
        ],
        "filter": null,
        "genres": [
          "string"
        ],
        "includeItemIds": [
          "string"
        ],
        "kinds": [
          "string"
        ],
        "libraryIds": [
          "string"
        ],
        "limit": 0,
        "order": "string",
        "recentDays": 0,
        "showIds": [
          "string"
        ],
        "text": "string",
        "yearFrom": 0,
        "yearThrough": 0
      },
      "weights": [
        {
          "itemId": "id_8h2k4q",
          "weight": 0
        }
      ]
    }
  ],
  "seed": "string",
  "templateId": "id_8h2k4q",
  "timezone": "2026-10-18T19:30:00Z",
  "viewerAccess": "string"
}

Schema

blocksarray of objectrequired
- anchorstringrequired
- endMinuteintegerrequired
- fallbackRuleIdstringrequired
- idstringrequired
- overrunstringrequired
- priorityintegerrequired
- ruleIdstringrequired
- startMinuteintegerrequired
- weekdaysarray of integerrequired
defaultRuleIdstringrequired
descriptionstringrequired
enabledbooleanrequired
idstringrequired
logoItemIdstringrequired
namestringrequired
overlayobjectrequired
- cornerstringrequired
- enabledbooleanrequired
- insetPercentintegerrequired
- sizePercentintegerrequired
- treatmentstringrequired
positionintegerrequired
protocolVersionstringrequired
qualityobjectrequired
- allowHdrToSdrbooleanrequired
- allowLossybooleanrequired
- maxBitrateintegerrequired
- maxHeightintegerrequired
- modestringrequired
rulesarray of objectrequired
- deduplicationWindowintegerrequired
- episodeModestringrequired
- exhaustionstringrequired
- idstringrequired
- maxConsecutiveintegerrequired
- modestringrequired
- namestringrequired
- queryobjectrequired
  - excludeItemIdsarray of string
  - filterany
  - genresarray of string
  - includeItemIdsarray of string
  - kindsarray of stringrequired
  - libraryIdsarray of stringrequired
  - limitintegerrequired
  - orderstringrequired
  - recentDaysintegerrequired
  - showIdsarray of stringrequired
  - textstring
  - yearFrominteger
  - yearThroughinteger
- weightsarray of objectrequired
  - itemIdstringrequired
  - weightnumberrequired
seedstringrequired
templateIdstringrequired
timezonestringrequired
viewerAccessstringrequired

Responses

200Successapplication/json

Example

{
  "preview": {
    "blocks": [
      {
        "anchor": "string",
        "fallbackRuleId": "id_8h2k4q",
        "id": "id_8h2k4q",
        "interval": {
          "end": {},
          "start": {},
          "timezone": "2026-10-18T19:30:00Z"
        },
        "overrun": "string",
        "priority": 0,
        "ruleId": "id_8h2k4q"
      }
    ],
    "boundaryPolicy": "string",
    "catalogFence": "string",
    "complete": true,
    "durationMs": 1800000,
    "firstDay": [
      {
        "channelId": "id_8h2k4q",
        "endMs": 1800000,
        "id": "id_8h2k4q",
        "itemId": "id_8h2k4q",
        "sourceOffsetMs": 1800000,
        "startMs": 1800000,
        "title": "Fargo",
        "unavailableReason": "string"
      }
    ],
    "rules": [
      {
        "complete": true,
        "durationMs": 1800000,
        "eligible": 0,
        "ruleId": "id_8h2k4q",
        "sample": [
          {}
        ],
        "scanned": 0,
        "semanticLimit": 0,
        "unresolved": 0
      }
    ],
    "window": {
      "end": {
        "actualLocal": "string",
        "adjustment": "string",
        "requestedLocal": "string",
        "utc": "2026-10-18T19:30:00Z"
      },
      "start": {
        "actualLocal": "string",
        "adjustment": "string",
        "requestedLocal": "string",
        "utc": "2026-10-18T19:30:00Z"
      },
      "timezone": "2026-10-18T19:30:00Z"
    }
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

previewobjectrequired
- blocksarray of objectrequired
  - anchorstringrequired
  - fallbackRuleIdstringrequired
  - idstringrequired
  - intervalobjectrequired
    endobjectrequired
    actualLocalstringrequired
    adjustmentstringrequired
    requestedLocalstringrequired
    utcstring (date-time)required
    startobjectrequired
    actualLocalstringrequired
    adjustmentstringrequired
    requestedLocalstringrequired
    utcstring (date-time)required
    timezonestringrequired
  - overrunstringrequired
  - priorityintegerrequired
  - ruleIdstringrequired
- boundaryPolicystringrequired
- catalogFencestringrequired
- completebooleanrequired
- durationMsintegerrequired
- firstDayarray of objectrequired
  - channelIdstringrequired
  - endMsintegerrequired
  - idstringrequired
  - itemIdstringrequired
  - sourceOffsetMsintegerrequired
  - startMsintegerrequired
  - titlestringrequired
  - unavailableReasonstringrequired
- rulesarray of objectrequired
  - completebooleanrequired
  - durationMsintegerrequired
  - eligibleintegerrequired
  - ruleIdstringrequired
  - samplearray of objectrequired
    assetIdstringrequired
    catalogBindingstringrequired
    durationMsintegerrequired
    episodeintegerrequired
    itemIdstringrequired
    libraryIdstringrequired
    seasonintegerrequired
    showIdstringrequired
    showTitlestring
    titlestringrequired
    weightnumberrequired
  - scannedintegerrequired
  - semanticLimitintegerrequired
  - unresolvedintegerrequired
- windowobjectrequired
  - endobjectrequired
    actualLocalstringrequired
    adjustmentstringrequired
    requestedLocalstringrequired
    utcstring (date-time)required
  - startobjectrequired
    actualLocalstringrequired
    adjustmentstringrequired
    requestedLocalstringrequired
    utcstring (date-time)required
  - timezonestringrequired
protocolVersionstringrequired
serverIdstringrequired

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/library-channels/preview" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "blocks": [
    {
      "anchor": "string",
      "endMinute": 0,
      "fallbackRuleId": "id_8h2k4q",
      "id": "id_8h2k4q",
      "overrun": "string",
      "priority": 0,
      "ruleId": "id_8h2k4q",
      "startMinute": 0,
      "weekdays": [
        0
      ]
    }
  ],
  "defaultRuleId": "id_8h2k4q",
  "description": "string",
  "enabled": true,
  "id": "id_8h2k4q",
  "logoItemId": "id_8h2k4q",
  "name": "Fargo",
  "overlay": {
    "corner": "string",
    "enabled": true,
    "insetPercent": 0,
    "sizePercent": 0,
    "treatment": "string"
  },
  "position": 0,
  "protocolVersion": "string",
  "quality": {
    "allowHdrToSdr": true,
    "allowLossy": true,
    "maxBitrate": 0,
    "maxHeight": 0,
    "mode": "string"
  },
  "rules": [
    {
      "deduplicationWindow": 0,
      "episodeMode": "string",
      "exhaustion": "string",
      "id": "id_8h2k4q",
      "maxConsecutive": 0,
      "mode": "string",
      "name": "Fargo",
      "query": {
        "excludeItemIds": [
          "string"
        ],
        "filter": null,
        "genres": [
          "string"
        ],
        "includeItemIds": [
          "string"
        ],
        "kinds": [
          "string"
        ],
        "libraryIds": [
          "string"
        ],
        "limit": 0,
        "order": "string",
        "recentDays": 0,
        "showIds": [
          "string"
        ],
        "text": "string",
        "yearFrom": 0,
        "yearThrough": 0
      },
      "weights": [
        {
          "itemId": "id_8h2k4q",
          "weight": 0
        }
      ]
    }
  ],
  "seed": "string",
  "templateId": "id_8h2k4q",
  "timezone": "2026-10-18T19:30:00Z",
  "viewerAccess": "string"
}'

POST/v1/admin/library-channels/reorderRun server library channels reorderadmin

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

Request body application/json · required

Example

{
  "channels": [
    {
      "expectedRevision": 0,
      "id": "id_8h2k4q"
    }
  ],
  "requestId": "id_8h2k4q"
}

Schema

channelsarray of objectrequired
- expectedRevisionintegerrequired
- idstringrequired
requestIdstringrequired

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "saved": true,
  "serverId": "id_8h2k4q"
}

Schema

protocolVersionstringrequired
savedbooleanrequired
serverIdstringrequired

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/library-channels/reorder" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channels":[{"expectedRevision":0,"id":"id_8h2k4q"}],"requestId":"id_8h2k4q"}'

GET/v1/admin/library-channels/templatesRead server library channels templatesadmin

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_library_channels_templates

Responses

200Successapplication/json

Example

{
  "protocolVersion": "string",
  "serverId": "id_8h2k4q",
  "templates": [
    {
      "applicable": true,
      "config": {
        "blocks": [
          {}
        ],
        "defaultRuleId": "id_8h2k4q",
        "description": "string",
        "enabled": true,
        "id": "id_8h2k4q",
        "logoItemId": "id_8h2k4q",
        "name": "Fargo",
        "overlay": {
          "corner": "string",
          "enabled": true,
          "insetPercent": 0,
          "sizePercent": 0,
          "treatment": "string"
        },
        "position": 0,
        "protocolVersion": "string",
        "quality": {
          "allowHdrToSdr": true,
          "allowLossy": true,
          "maxBitrate": 0,
          "maxHeight": 0,
          "mode": "string"
        },
        "rules": [
          {}
        ],
        "seed": "string",
        "templateId": "id_8h2k4q",
        "timezone": "2026-10-18T19:30:00Z",
        "viewerAccess": "string"
      },
      "description": "string",
      "id": "id_8h2k4q",
      "minimumCandidates": 0,
      "name": "Fargo",
      "reason": "string"
    }
  ]
}

Schema

protocolVersionstringrequired
serverIdstringrequired
templatesarray of objectrequired
- applicablebooleanrequired
- configobjectrequired
  - blocksarray of objectrequired
    anchorstringrequired
    endMinuteintegerrequired
    fallbackRuleIdstringrequired
    idstringrequired
    overrunstringrequired
    priorityintegerrequired
    ruleIdstringrequired
    startMinuteintegerrequired
    weekdaysarray of integerrequired
  - defaultRuleIdstringrequired
  - descriptionstringrequired
  - enabledbooleanrequired
  - idstringrequired
  - logoItemIdstringrequired
  - namestringrequired
  - overlayobjectrequired
    cornerstringrequired
    enabledbooleanrequired
    insetPercentintegerrequired
    sizePercentintegerrequired
    treatmentstringrequired
  - positionintegerrequired
  - protocolVersionstringrequired
  - qualityobjectrequired
    allowHdrToSdrbooleanrequired
    allowLossybooleanrequired
    maxBitrateintegerrequired
    maxHeightintegerrequired
    modestringrequired
  - rulesarray of objectrequired
    deduplicationWindowintegerrequired
    episodeModestringrequired
    exhaustionstringrequired
    idstringrequired
    maxConsecutiveintegerrequired
    modestringrequired
    namestringrequired
    queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
    weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
  - seedstringrequired
  - templateIdstringrequired
  - timezonestringrequired
  - viewerAccessstringrequired
- descriptionstringrequired
- idstringrequired
- minimumCandidatesintegerrequired
- namestringrequired
- reasonstringrequired

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

POST/v1/admin/library-channels/templates/{id}/installRun server library channels templates installadmin

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

Parameters

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

Request body application/json · required

Example

{
  "requestId": "id_8h2k4q",
  "timezone": "2026-10-18T19:30:00Z"
}

Schema

requestIdstringrequired
timezonestringrequired

Responses

200Successapplication/json

Example

{
  "channel": {
    "candidateCount": 0,
    "config": {
      "blocks": [
        {
          "anchor": "string",
          "endMinute": 0,
          "fallbackRuleId": "id_8h2k4q",
          "id": "id_8h2k4q",
          "overrun": "string",
          "priority": 0,
          "ruleId": "id_8h2k4q",
          "startMinute": 0,
          "weekdays": []
        }
      ],
      "defaultRuleId": "id_8h2k4q",
      "description": "string",
      "enabled": true,
      "id": "id_8h2k4q",
      "logoItemId": "id_8h2k4q",
      "name": "Fargo",
      "overlay": {
        "corner": "string",
        "enabled": true,
        "insetPercent": 0,
        "sizePercent": 0,
        "treatment": "string"
      },
      "position": 0,
      "protocolVersion": "string",
      "quality": {
        "allowHdrToSdr": true,
        "allowLossy": true,
        "maxBitrate": 0,
        "maxHeight": 0,
        "mode": "string"
      },
      "rules": [
        {
          "deduplicationWindow": 0,
          "episodeMode": "string",
          "exhaustion": "string",
          "id": "id_8h2k4q",
          "maxConsecutive": 0,
          "mode": "string",
          "name": "Fargo",
          "query": {},
          "weights": []
        }
      ],
      "seed": "string",
      "templateId": "id_8h2k4q",
      "timezone": "2026-10-18T19:30:00Z",
      "viewerAccess": "string"
    },
    "generatedThrough": "string",
    "generation": "string",
    "healthCode": "string",
    "replacementBoundary": "string",
    "revision": 0,
    "state": "string",
    "unresolvedDurationCount": 0
  },
  "protocolVersion": "string",
  "serverId": "id_8h2k4q"
}

Schema

channelobjectrequired
- candidateCountintegerrequired
- configobjectrequired
  - blocksarray of objectrequired
    anchorstringrequired
    endMinuteintegerrequired
    fallbackRuleIdstringrequired
    idstringrequired
    overrunstringrequired
    priorityintegerrequired
    ruleIdstringrequired
    startMinuteintegerrequired
    weekdaysarray of integerrequired
  - defaultRuleIdstringrequired
  - descriptionstringrequired
  - enabledbooleanrequired
  - idstringrequired
  - logoItemIdstringrequired
  - namestringrequired
  - overlayobjectrequired
    cornerstringrequired
    enabledbooleanrequired
    insetPercentintegerrequired
    sizePercentintegerrequired
    treatmentstringrequired
  - positionintegerrequired
  - protocolVersionstringrequired
  - qualityobjectrequired
    allowHdrToSdrbooleanrequired
    allowLossybooleanrequired
    maxBitrateintegerrequired
    maxHeightintegerrequired
    modestringrequired
  - rulesarray of objectrequired
    deduplicationWindowintegerrequired
    episodeModestringrequired
    exhaustionstringrequired
    idstringrequired
    maxConsecutiveintegerrequired
    modestringrequired
    namestringrequired
    queryobjectrequired
    excludeItemIdsarray of string
    filterany
    genresarray of string
    includeItemIdsarray of string
    kindsarray of stringrequired
    libraryIdsarray of stringrequired
    limitintegerrequired
    orderstringrequired
    recentDaysintegerrequired
    showIdsarray of stringrequired
    textstring
    yearFrominteger
    yearThroughinteger
    weightsarray of objectrequired
    itemIdstringrequired
    weightnumberrequired
  - seedstringrequired
  - templateIdstringrequired
  - timezonestringrequired
  - viewerAccessstringrequired
- generatedThroughstringrequired
- generationstringrequired
- healthCodestringrequired
- replacementBoundarystringrequired
- revisionintegerrequired
- statestringrequired
- unresolvedDurationCountintegerrequired
protocolVersionstringrequired
serverIdstringrequired

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/library-channels/templates/{id}/install" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"requestId":"id_8h2k4q","timezone":"2026-10-18T19:30:00Z"}'