REST API
Every action the dashboard takes, as an HTTP call. Generated from the OpenAPI document the control plane builds from its own routes, so nothing here is listed that it does not serve.
Calling it
Paths are relative to your control plane's /control-plane/api/v1. Issue an API token in the dashboard (Developers → API tokens) and send it as a bearer token. Errors answer with a PBP- code listed on the error codes page. The same document is in the @pb-play/api-client package for generating a client in any language.
curl -H "Authorization: Bearer pbp_tok_…" https://<your-control-plane>/control-plane/api/v1/accountaccount
- Answers 200 AccountResponse
- Answers 200 DeploymentResponse
tokens
- Answers 200 TokenResponse[]
Roles: owner, admin — a signed-in person or an API token holding one of them. A signed-in person only: an API token is refused (PBP-109044).
Body · IssueTokenAnswers 201 IssuedTokenResponseexpiresAtstring | nulloptionalnamestringrole"admin" | "billing" | "member" | "owner"optionalscopesobject | nulloptional
Roles: owner, admin — a signed-in person or an API token holding one of them. A signed-in person only: an API token is refused (PBP-109044).
ParametersAnswers 200 TokenResponsetokenIdstringpath
webhooks
- Answers 200 WebhookResponse[]
Roles: owner, admin — a signed-in person or an API token holding one of them.
Body · CreateWebhookAnswers 201 CreatedWebhookResponseenabledbooleanoptionalevents"captions.generated" | "key.rotated" | "key.revoked" | "licence.changed" | "live.ended" | "live.started" | "media.encode_failed" | "media.encoded" | "usage.threshold" | "version.promoted"[]urlstring
- ParametersAnswers 200 DeliveryResponse[]
endpointIdstringoptionalquerylimitintegeroptionalquery
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 201 DeliveryResponsedeliveryIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterswebhookIdstringpath
Body · UpdateWebhookAnswers 200 WebhookResponseenabledbooleanoptionalevents"captions.generated" | "key.rotated" | "key.revoked" | "licence.changed" | "live.ended" | "live.started" | "media.encode_failed" | "media.encoded" | "usage.threshold" | "version.promoted"[]optionalurlstringoptional
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 204, no bodywebhookIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 201 DeliveryResponsewebhookIdstringpath
billing
- Answers 200 SubscriptionResponse
- Answers 200 PlanResponse[]
Roles: owner, billing — a signed-in person or an API token holding one of them.
Body · ChangePlanAnswers 200 SubscriptionResponseplan"developer" | "starter" | "growth"
Roles: owner, billing — a signed-in person or an API token holding one of them.
Body · SetCardAnswers 200 SubscriptionResponsetokenstring
Roles: owner, billing — a signed-in person or an API token holding one of them.
Body · CardSetupAnswers 200 objectreturnUrlstring
- Answers 200 InvoiceSummary[]
- ParametersAnswers 200 InvoiceResponse
invoiceIdstringpath
- ParametersAnswers 200 StreamableFile
invoiceIdstringpath
Roles: owner, billing — a signed-in person or an API token holding one of them.
Body · BillingProfileAnswers 200 SubscriptionResponseaddressobject | nullemailstring | nulloptionalnamestringtaxIdstring | nulloptional
- Answers 200 UsageResponse
billingProcessor
Public: no credential, readable from any origin.
Answers 204, no body
analytics
- ParametersAnswers 200 Overview
propertyIdstringpathfromstringoptionalquerygranularity"day" | "hour"optionalquerytostringoptionalquery
- ParametersAnswers 200 object
propertyIdstringpath
- ParametersAnswers 200 object
propertyIdstringpathby"browser" | "coreVersion" | "country" | "engine" | "media" | "os" | "platform" | "player" | "streamType"optionalqueryfromstringoptionalquerytostringoptionalquery
- ParametersAnswers 200 string
propertyIdstringpathby"browser" | "coreVersion" | "country" | "engine" | "media" | "os" | "platform" | "player" | "streamType"optionalqueryfromstringoptionalquerytostringoptionalquery
- ParametersAnswers 200 object[]
propertyIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 200 objectpropertyIdstringpathviewerHashstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 200 ExportDestinationDto | nullpropertyIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterspropertyIdstringpath
Body · UpsertExportDestinationAnswers 200 ExportDestinationDtoaccessKeyIdstringbucketstringendpointstring | nulloptionalkind"s3"optionalprefixstringoptionalregionstringsecretAccessKeystring
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 204, no bodypropertyIdstringpath
apps
- ParametersAnswers 200 AppResponse[]
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · WriteAppAnswers 201 AppResponseadScheduleIdstring | nulloptionalbundleIdsBundleIdsoptionalconfigAppConfig | nulloptionallicenceKeyIdstring | nulloptionallocalestring | nulloptionalnamestringoriginsOriginsoptionalplayerIdstring | nulloptionalplaylistIdsstring[]optionalthemeThemeDocument | nulloptional
- ParametersAnswers 200 AppResponse
propertyIdstringpathappIdstringpath
- Parameters
propertyIdstringpathappIdstringpath
Body · WriteAppAnswers 200 AppResponseadScheduleIdstring | nulloptionalbundleIdsBundleIdsoptionalconfigAppConfig | nulloptionallicenceKeyIdstring | nulloptionallocalestring | nulloptionalnamestringoriginsOriginsoptionalplayerIdstring | nulloptionalplaylistIdsstring[]optionalthemeThemeDocument | nulloptional
- ParametersAnswers 204, no body
propertyIdstringpathappIdstringpath
audit
- ParametersAnswers 200 AuditPageResponse
propertyIdstringpathbeforestringoptionalquerylimitintegeroptionalquery
properties
- Answers 200 PropertyResponse[]
Roles: owner, admin — a signed-in person or an API token holding one of them.
Body · CreatePropertyAnswers 201 PropertyResponseallowedOriginsOriginsoptionalnamestring
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 204, no bodypropertyIdstringpath
- Parameters
propertyIdstringpath
Body · UpdatePropertyAnswers 200 PropertyResponseautoTranscribeobject | string | nulloptionalmediaBaseUrlstring | nulloptionalnamestringoptional
- ParametersAnswers 200 PropertyDrmDto | null
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · UpsertPropertyDrmAnswers 200 PropertyDrmDtofairplayobject | nulloptionalkeystringoptionalkeyIdstringoptionalplayreadyobject | nulloptionalwidevineobject | nulloptional
- ParametersAnswers 204, no body
propertyIdstringpath
- Parameters
propertyIdstringpathmediaIdstringpath
Body · SetMediaDrmAnswers 200 MediaResponsekeystringoptionalkeyIdstringoptionalpackagedboolean
keys
- ParametersAnswers 200 KeyResponse[]
propertyIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterspropertyIdstringpath
Body · IssueKeyAnswers 201 KeyResponseappIdstring | nulloptionalbundleIdsBundleIdsoptionalcertificateDigestsstring[]optionalenvironment"development" | "production"originsOriginsoptionalplatform"web" | "android" | "ios" | "roku"optional
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterspropertyIdstringpathkeyIdstringpath
Body · UpdateKeyAnswers 200 KeyResponsebundleIdsBundleIdscertificateDigestsstring[]optionaloriginsOriginsoptional
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 204, no bodypropertyIdstringpathkeyIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 201 KeyResponsepropertyIdstringpathkeyIdstringpath
origins
- ParametersAnswers 200 string[]
propertyIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterspropertyIdstringpath
Body · ReplaceOriginsAnswers 200 string[]originsOrigins
media
- ParametersAnswers 200 PaginatedMedia
propertyIdstringpathcollectionstringoptionalquerycustomMatch"all" | "any"optionalquerycustomMode"exclude" | "include"optionalquerycustomParamCustomListoptionalquerydateField"created" | "updated"optionalquerydateFromDateOnlyoptionalquerydateToDateOnlyoptionalquerydirection"asc" | "desc"optionalqueryhostingListoptionalquerylimitintegeroptionalqueryoffsetintegeroptionalquerysearchstringoptionalquerysort"created" | "duration" | "id" | "title" | "updated"optionalquerysourceTypeListoptionalquerystatusListoptionalquerytagListoptionalquerytagMatch"all" | "any"optionalquerytagMode"exclude" | "include"optionalquery
- Parameters
propertyIdstringpath
Body · RegisterMediaAnswers 201 MediaResponseadCuesnumber[]optionaladMode"bookends" | "default" | "none"optionalconfigMediaConfigoptionalcustomobjectoptionaldescriptionstring | nulloptionaldurationinteger | nulloptionalexpectedUpdatedAtstringoptionalexpiresAtstring | nulloptionalgeoRuleIdstring | nulloptionalheightintegeroptionalimagesobject[]optionalmotionPosterMediaUrl | nulloptionalposterMediaUrl | nulloptionalprojection"equirectangular" | "equirectangular-top-bottom" | "equirectangular-side-by-side" | nulloptionalpublishedAtstring | nulloptionalsourcesobject[]tagsstring[]optionaltitlestringtracksobject[]optionalviewsobject[]optionalwidthintegeroptional
- Parameters
propertyIdstringpath
Body · BulkMediaAnswers 200 objectaction"remove" | "set-geo-rule" | "add-to-playlist" | "add-to-collection" | "remove-from-collection" | "add-tags"idsstring[]tagsstring[]optionalvaluestring | nulloptional
- ParametersAnswers 200 string[]
propertyIdstringpath
- ParametersAnswers 200 object
propertyIdstringpathurlstringoptionalquery
- ParametersAnswers 200 MediaUsageResponse
propertyIdstringpath
- ParametersAnswers 200 UploadCapabilityResponse
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · CreateUploadAnswers 201 UploadTicketResponsecontentTypestringfilenamestringmediaIdstringsizeinteger
- ParametersAnswers 200 object
propertyIdstringpath
- ParametersAnswers 200 MediaResponse
propertyIdstringpathmediaIdstringpath
- Parameters
propertyIdstringpathmediaIdstringpath
Body · RegisterMediaAnswers 200 MediaResponseadCuesnumber[]optionaladMode"bookends" | "default" | "none"optionalconfigMediaConfigoptionalcustomobjectoptionaldescriptionstring | nulloptionaldurationinteger | nulloptionalexpectedUpdatedAtstringoptionalexpiresAtstring | nulloptionalgeoRuleIdstring | nulloptionalheightintegeroptionalimagesobject[]optionalmotionPosterMediaUrl | nulloptionalposterMediaUrl | nulloptionalprojection"equirectangular" | "equirectangular-top-bottom" | "equirectangular-side-by-side" | nulloptionalpublishedAtstring | nulloptionalsourcesobject[]tagsstring[]optionaltitlestringtracksobject[]optionalviewsobject[]optionalwidthintegeroptional
- ParametersAnswers 204, no body
propertyIdstringpathmediaIdstringpath
- ParametersAnswers 200 PlaybackObjectResponse
propertyIdstringpathmediaIdstringpath
- ParametersAnswers 200 object
propertyIdstringpathmediaIdstringpath
- ParametersAnswers 200 object
propertyIdstringpathmediaIdstringpath
- Parameters
propertyIdstringpathmediaIdstringpath
Body · SelectStillAnswers 201 objectatSecondsnumber
- Parameters
propertyIdstringpathmediaIdstringpath
Body · RequestTranscriptionAnswers 201 TranscriptionResponselanguageTranscriptionLanguageoptional
- ParametersAnswers 200 TranscriptionResponse
propertyIdstringpathmediaIdstringpath
- Parameters
propertyIdstringpathmediaIdstringpath
Body · InspectRemoteAnswers 201 objecturlstring
A signed-in person only: an API token is refused (PBP-109044).
ParameterspropertyIdstringpathmediaIdstringpath
Body · PrepareDownloadAnswers 201 DownloadResponseheightinteger
- Parameters
propertyIdstringpathmediaIdstringpath
Body · SetEncryptionAnswers 200 MediaResponseencryptedboolean
- Parameters
propertyIdstringpathmediaIdstringpath
Body · OpenUploadAnswers 201 objectcontentTypestringoptionalfilenamestringsizeinteger
- ParametersAnswers 200 object
propertyIdstringpathmediaIdstringpathuploadIdstringpath
- ParametersAnswers 204, no body
propertyIdstringpathmediaIdstringpathuploadIdstringpath
- ParametersAnswers 200 object
propertyIdstringpathmediaIdstringpathuploadIdstringpathfromstringoptionalquery
- ParametersAnswers 201 object
propertyIdstringpathmediaIdstringpathuploadIdstringpath
collections
- ParametersAnswers 200 CollectionResponse[]
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · WriteCollectionAnswers 201 CollectionResponsedescriptionstring | nulloptionaltitlestring
- Parameters
propertyIdstringpathcollectionIdstringpath
Body · WriteCollectionAnswers 200 CollectionResponsedescriptionstring | nulloptionaltitlestring
- ParametersAnswers 204, no body
propertyIdstringpathcollectionIdstringpath
geoRules
- ParametersAnswers 200 GeoRuleResponse[]
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · WriteGeoRuleAnswers 201 GeoRuleResponsecountriesstring[]optionalmode"allow" | "deny"namestring
- Parameters
propertyIdstringpathruleIdstringpath
Body · WriteGeoRuleAnswers 200 GeoRuleResponsecountriesstring[]optionalmode"allow" | "deny"namestring
- ParametersAnswers 204, no body
propertyIdstringpathruleIdstringpath
liveStreams
- ParametersAnswers 200 LiveStreamResponse[]
propertyIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterspropertyIdstringpath
Body · WriteLiveStreamAnswers 201 LiveStreamWithKeyResponsenamestring
- ParametersAnswers 200 LiveStreamResponse
propertyIdstringpathliveStreamIdstringpath
- Parameters
propertyIdstringpathliveStreamIdstringpath
Body · WriteLiveStreamAnswers 200 LiveStreamResponsenamestring
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 204, no bodypropertyIdstringpathliveStreamIdstringpath
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParametersAnswers 201 LiveStreamWithKeyResponsepropertyIdstringpathliveStreamIdstringpath
logs
- ParametersAnswers 200 LogsPageResponse
propertyIdstringpathcursorstringoptionalquerykind"api" | "encode" | "webhook" | "licence"optionalquerylimitintegeroptionalquery
playlists
- ParametersAnswers 200 PaginatedPlaylists
propertyIdstringpathcustomMatch"all" | "any"optionalquerycustomMode"exclude" | "include"optionalquerycustomParamCustomListoptionalquerydateField"created" | "updated"optionalquerydateFromDateOnlyoptionalquerydateToDateOnlyoptionalquerydirection"asc" | "desc"optionalquerylimitintegeroptionalqueryoffsetintegeroptionalquerysearchstringoptionalquerysort"created" | "id" | "items" | "title" | "updated"optionalquery
- Parameters
propertyIdstringpath
Body · WritePlaylistAnswers 201 PlaylistResponsecustomobjectoptionaldescriptionstring | nulloptionalendsAtstring | nulloptionalentryWindowsobjectoptionalkind"dynamic" | "manual"optionalmediaIdsstring[]optionalrulesPlaylistRules | nulloptionalstartsAtstring | nulloptionaltitlestring
- ParametersAnswers 200 PlaylistResponse
propertyIdstringpathplaylistIdstringpath
- Parameters
propertyIdstringpathplaylistIdstringpath
Body · WritePlaylistAnswers 200 PlaylistResponsecustomobjectoptionaldescriptionstring | nulloptionalendsAtstring | nulloptionalentryWindowsobjectoptionalkind"dynamic" | "manual"optionalmediaIdsstring[]optionalrulesPlaylistRules | nulloptionalstartsAtstring | nulloptionaltitlestring
- ParametersAnswers 204, no body
propertyIdstringpathplaylistIdstringpath
- ParametersAnswers 200 PlaylistItemResponse[]
propertyIdstringpathplaylistIdstringpath
players
- ParametersAnswers 200 PlayerResponse[]
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · WritePlayerAnswers 201 PlayerResponseadScheduleIdstring | nulloptionalconfigPlayerConfigoptionalnamestringthemeThemeDocumentoptional
- ParametersAnswers 200 PlayerResponse
propertyIdstringpathplayerIdstringpath
- Parameters
propertyIdstringpathplayerIdstringpath
Body · WritePlayerAnswers 200 PlayerResponseadScheduleIdstring | nulloptionalconfigPlayerConfigoptionalnamestringthemeThemeDocumentoptional
- ParametersAnswers 204, no body
propertyIdstringpathplayerIdstringpath
adSchedules
- ParametersAnswers 200 AdScheduleResponse[]
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · WriteAdScheduleAnswers 201 AdScheduleResponsebreaksobject[]optionalclient"ima" | "vast"optionalmode"breaks" | "vmap"optionalnamestringrulesobjectoptionalvmapUrlAbsoluteUrl | nulloptionalvpaidMode"disabled" | "enabled" | "insecure"optional
- ParametersAnswers 200 AdScheduleResponse
propertyIdstringpathscheduleIdstringpath
- Parameters
propertyIdstringpathscheduleIdstringpath
Body · WriteAdScheduleAnswers 200 AdScheduleResponsebreaksobject[]optionalclient"ima" | "vast"optionalmode"breaks" | "vmap"optionalnamestringrulesobjectoptionalvmapUrlAbsoluteUrl | nulloptionalvpaidMode"disabled" | "enabled" | "insecure"optional
- ParametersAnswers 204, no body
propertyIdstringpathscheduleIdstringpath
publicAdSchedules
Public: no credential, readable from any origin.
ParametersAnswers 200 PublicAdSchedulescheduleIdstringpath
publicApps
Public: no credential, readable from any origin.
ParametersAnswers 200 PublicAppappIdstringpath
Public: no credential, readable from any origin.
ParametersAnswers 200 PublicPlayerappIdstringpath
publicContinueWatching
Public: no credential, readable from any origin.
ParametersAnswers 204, no bodypropertyIdstringpathviewerIdstringpath
Public: no credential, readable from any origin.
ParametersAnswers 200 objectpropertyIdstringpathviewerIdstringpath
publicMedia
Public: no credential, readable from any origin.
ParametersAnswers 200 PlaybackObjectmediaIdstringpath
publicOembed
Public: no credential, readable from any origin.
ParametersAnswers 200 OembedResponseformatstringoptionalquerymaxheightintegeroptionalquerymaxwidthintegeroptionalqueryurlstringquery
publicPlans
Public: no credential, readable from any origin.
Answers 200 PublicPlan[]
publicPlayers
Public: no credential, readable from any origin.
ParametersAnswers 200 PublicPlayerplayerIdstringpath
publicPlaylists
Public: no credential, readable from any origin.
ParametersAnswers 200 string | PlaylistFeedplaylistIdstringpathformatstringoptionalquerylimitintegeroptionalqueryoffsetintegeroptionalquery
publicRecommended
Public: no credential, readable from any origin.
ParametersAnswers 200 RecommendedFeedcountintegeroptionalquerymediastringqueryplayliststringoptionalquery
publicReleases
Public: no credential, readable from any origin.
Answers 200 PublishedRelease[]
publicStatus
Public: no credential, readable from any origin.
Answers 200 PublicStatusPublic: no credential, readable from any origin.
Answers 200 stringPublic: no credential, readable from any origin.
Answers 202 objectPublic: no credential, readable from any origin.
ParametersAnswers 200 objecttokenstringoptionalquery
Public: no credential, readable from any origin.
ParametersAnswers 200 objecttokenstringoptionalquery
publicUptime
Public: no credential, readable from any origin.
Answers 200 SurfaceUptime[]
versions
- ParametersAnswers 200 VersionPolicyResponse
propertyIdstringpath
- Parameters
propertyIdstringpath
Body · UpdateVersionPolicyAnswers 200 VersionPolicyResponsechannel"dev" | "beta" | "stable" | string | nullpinstring | null
- Parameters
propertyIdstringpath
Body · UpdateEntityPinsAnswers 200 VersionPolicyResponsepinsobject[]
Roles: owner, admin — a signed-in person or an API token holding one of them.
ParameterspropertyIdstringpath
Body · UpdateAccountChannelAnswers 200 VersionPolicyResponsechannel"dev" | "beta" | "stable" | string | null