plycdn SDK method reference
Every call of the server packages (the observability calls are listed in the Observability guide), with its route, side by side for ASP.NET Core, Node.js and Python, and the browser packages where a page can make the call. Use it to find the method for a task, or to move code from one language to another: the names correspond one to one.
1How names correspond
The ASP.NET Core name is the reference. Node.js uses the same name without Async and with a lower-case first letter (RegisterAssetAsync becomes registerAsset). Python uses snake case without Async (register_asset); the async clients (AsyncPlycdnContentApi, AsyncPlycdnStorageApi, AsyncPlycdnVideoApi) have the same names. Two Python names differ because of the language: import_assets for ImportAsync, and create_client_from_regions / create_service_client_from_regions for CreateClientAsync / CreateServiceClientAsync. Routes are relative to https://api.plycdn.com/api/content/v1.
Each call belongs to a kind of key and a place it may run:
| Kind | Where it runs | Key |
|---|---|---|
| Browser | Called by a page through routes your backend hosts; your backend holds the key and decides who the caller is. | Standard key (kept on your server) |
| Server | Your backend only. | Standard key |
| Admin | Your backend only, in the automation that sets accounts, buckets, libraries and live inputs up. Refused for a standard key with admin_key_required. |
Admin key |
| You work with | Package | Class |
|---|---|---|
| Content Search | Plycdn.ContentSearch.AspNetCore, @plycdn/content-search-node, plycdn-content-search |
PlycdnContentApi (and AsyncPlycdnContentApi in Python) |
| Storage and delivery | Plycdn.AspNetCore.Storage, @plycdn/node, plycdn |
PlycdnStorageApi |
| Video, webhooks, live streaming and watch pages | Plycdn.AspNetCore.Video, @plycdn/node, plycdn |
PlycdnVideoApi |
| Sub-organizations, quotas, statements and the account audit | Any of the above | PlycdnAccountApi (Content Search) or PlycdnOrganizationApi (storage and video) |
Logs, metrics and traces have their own guide: Observability.
2Search, answers and suggestions
Content Search packages
| Task | Route | Kind | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|
| Capabilities | GET /capabilities |
browser | GetCapabilitiesAsync |
getCapabilities |
get_capabilities |
capabilities |
useCapabilities |
| Activity | GET /activity |
browser | GetActivityAsync |
getActivity |
get_activity |
activity |
useActivity |
| Search | POST /search |
browser | SearchAsync |
search |
search |
search |
useSearch |
| Answer | POST /answer |
browser | AnswerAsync |
answer |
answer |
answer |
useAnswer |
| Assistant | POST /answer |
browser | StreamAnswerAsync |
streamAnswer |
stream_answer |
streamAnswer |
usePlycdnAssistant |
| Suggest | GET /suggest |
browser | SuggestAsync |
suggest |
suggest |
suggest |
useSuggestions |
| Plan | GET /plan |
browser | GetPlanAsync |
getPlan |
get_plan |
plan |
usePlan |
3Registering and following content
Content Search packages
| Task | Route | Kind | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|
| Register | POST /assets |
server | RegisterAssetAsync |
registerAsset |
register_asset |
||
| Import | POST /imports |
server | ImportAsync |
import |
import_assets |
||
| List assets | GET /assets |
browser | ListAssetsAsync |
listAssets |
list_assets |
assets |
useAssets |
| One asset | GET /assets/{asset_id} |
browser | GetAssetAsync |
getAsset |
get_asset |
asset |
useAsset |
| Asset jobs | GET /assets/{asset_id}/jobs |
browser | GetAssetJobsAsync |
getAssetJobs |
get_asset_jobs |
assetJobs |
useAssetJobs |
| Job | GET /jobs/{job_id} |
browser | GetJobAsync |
getJob |
get_job |
job |
useJob |
| Import status | GET /imports/{import_id} |
browser | GetImportAsync |
getImport |
get_import |
||
| Reindex | POST /assets/{asset_id}/reindex |
browser | ReindexAsync |
reindex |
reindex |
reindex |
useReindex |
| Cancel job | POST /jobs/{job_id}/cancel |
browser | CancelJobAsync |
cancelJob |
cancel_job |
cancel |
useCancelJob |
| Delete asset | DELETE /assets/{asset_id} |
browser | DeleteAssetAsync |
deleteAsset |
delete_asset |
||
| Renew source access | PUT /assets/{asset_id}/source-access |
server | RenewSourceAccessAsync |
renewSourceAccess |
renew_source_access |
||
| Transcript | GET /assets/{asset_id}/transcript |
server | GetTranscriptAsync |
getTranscript |
get_transcript |
||
| Correct transcript | PATCH /assets/{asset_id}/transcript |
server | CorrectTranscriptAsync |
correctTranscript |
correct_transcript |
||
| Related | GET /assets/{asset_id}/related |
browser | GetRelatedAsync |
getRelated |
get_related |
related |
useRelated |
| Passages | GET /assets/{asset_id}/passages |
browser | GetPassagesAsync |
getPassages |
get_passages |
passages |
usePassages |
| Asset playback | GET /assets/{asset_id}/playback |
server | GetPlaybackAsync |
getPlayback |
get_playback |
||
| Deletion receipts | GET /deletion-receipts |
admin | ListDeletionReceiptsAsync |
listDeletionReceipts |
list_deletion_receipts |
||
| Read metadata | GET /assets/{asset_id}/metadata |
admin | GetMetadataAsync |
getMetadata |
get_metadata |
||
| Write metadata | PUT /assets/{asset_id}/metadata |
admin | SetMetadataAsync |
setMetadata |
set_metadata |
||
| Read permissions | GET /assets/{asset_id}/permissions |
admin | GetPermissionsAsync |
getPermissions |
get_permissions |
||
| Write permissions | PUT /assets/{asset_id}/permissions |
admin | SetPermissionsAsync |
setPermissions |
set_permissions |
4Metadata, permissions, collections and tuning
Content Search packages
| Task | Route | Kind | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|
| List collections | GET /collections |
admin | ListCollectionsAsync |
listCollections |
list_collections |
||
| Upsert collection | PUT /collections/{external_id} |
admin | UpsertCollectionAsync |
upsertCollection |
upsert_collection |
||
| Delete collection | DELETE /collections/{external_id} |
admin | DeleteCollectionAsync |
deleteCollection |
delete_collection |
||
| Collection members | PUT /collections/{external_id}/assets |
admin | SetCollectionMembersAsync |
setCollectionMembers |
set_collection_members |
||
| Collection from documents | POST /collections |
browser | CreateCollectionFromDocumentsAsync |
createCollectionFromDocuments |
create_collection_from_documents |
createCollection |
createCollection |
| Read synonyms | GET /tuning/synonyms |
admin | GetSynonymsAsync |
getSynonyms |
get_synonyms |
||
| Write synonyms | PUT /tuning/synonyms |
admin | SetSynonymsAsync |
setSynonyms |
set_synonyms |
||
| List boosts | GET /tuning/boosts |
admin | ListBoostsAsync |
listBoosts |
list_boosts |
||
| Write boost | PUT /tuning/boosts/{name} |
admin | SetBoostAsync |
setBoost |
set_boost |
||
| Delete boost | DELETE /tuning/boosts/{name} |
admin | DeleteBoostAsync |
deleteBoost |
delete_boost |
||
| List pins | GET /tuning/pins |
admin | ListPinsAsync |
listPins |
list_pins |
||
| Write pins | PUT /tuning/pins |
admin | SetPinsAsync |
setPins |
set_pins |
5Connectors and settings
Content Search packages
| Task | Route | Kind | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|
| List connectors | GET /connectors |
admin | ListConnectorsAsync |
listConnectors |
list_connectors |
||
| Create connector | POST /connectors |
admin | CreateConnectorAsync |
createConnector |
create_connector |
||
| One connector | GET /connectors/{connector_id} |
admin | GetConnectorAsync |
getConnector |
get_connector |
||
| Update connector | PUT /connectors/{connector_id} |
admin | UpdateConnectorAsync |
updateConnector |
update_connector |
||
| Delete connector | DELETE /connectors/{connector_id} |
admin | DeleteConnectorAsync |
deleteConnector |
delete_connector |
||
| Sync connector | POST /connectors/{connector_id}/sync |
admin | SyncConnectorAsync |
syncConnector |
sync_connector |
||
| Read settings | GET /settings |
server | GetSettingsAsync |
getSettings |
get_settings |
||
| Clear settings | DELETE /settings |
admin | ClearSettingsAsync |
clearSettings |
clear_settings |
||
| Change settings | PATCH /settings |
admin | UpdateSettingsAsync |
updateSettings |
update_settings |
6Usage, health and analytics
Content Search packages
| Task | Route | Kind | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|
| Search analytics | GET /analytics/searches |
admin | GetSearchAnalyticsAsync |
getSearchAnalytics |
get_search_analytics |
||
| Usage | GET /usage |
admin | GetUsageAsync |
getUsage |
get_usage |
||
| Usage daily | GET /usage/daily |
admin | GetUsageDailyAsync |
getUsageDaily |
get_usage_daily |
||
| Usage by asset | GET /usage/assets |
admin | GetUsageByAssetAsync |
getUsageByAsset |
get_usage_by_asset |
||
| Library health | GET /analytics/library |
admin | GetLibraryHealthAsync |
getLibraryHealth |
get_library_health |
||
| Usage quotas | GET /usage/quotas |
admin | GetUsageQuotasAsync |
getUsageQuotas |
get_usage_quotas |
||
| Organization quotas | GET /usage/quotas/organizations/{organization_id} |
admin | GetOrganizationQuotasAsync |
getOrganizationQuotas |
get_organization_quotas |
||
| Set organization quotas | PUT /usage/quotas/organizations/{organization_id} |
admin | SetOrganizationQuotasAsync |
setOrganizationQuotas |
set_organization_quotas |
||
| List statements | GET /statements |
admin | ListStatementsAsync |
listStatements |
list_statements |
||
| One statement | GET /statements/{month} |
admin | GetStatementAsync |
getStatement |
get_statement |
||
| Export statement | GET /statements/{month}/export |
admin | ExportStatementCsvAsync |
exportStatementCsv |
export_statement_csv |
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| Usage by resource | GET /usage/resources |
admin | PlycdnStorageApi |
GetUsageByResourceAsync |
getUsageByResource |
get_usage_by_resource |
||
| Delivery analytics series | GET /analytics/delivery |
admin | PlycdnStorageApi |
GetDeliveryAnalyticsSeriesAsync |
getDeliveryAnalyticsSeries |
get_delivery_analytics_series |
||
| Delivery analytics breakdown | GET /analytics/delivery/breakdown |
admin | PlycdnStorageApi |
GetDeliveryBreakdownAsync |
getDeliveryBreakdown |
get_delivery_breakdown |
7Buckets and uploads
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| Regions | GET /regions |
admin | PlycdnStorageApi |
ListRegionsAsync |
listRegions |
list_regions |
||
| Bucket name availability | GET /bucket-names |
admin | PlycdnStorageApi |
CheckBucketNameAsync |
checkBucketName |
check_bucket_name |
||
| Create bucket | POST /buckets |
admin | PlycdnStorageApi |
CreateBucketAsync |
createBucket |
create_bucket |
||
| List buckets | GET /buckets |
admin | PlycdnStorageApi |
ListBucketsAsync |
listBuckets |
list_buckets |
||
| One bucket | GET /buckets/{bucket_id} |
admin | PlycdnStorageApi |
GetBucketAsync |
getBucket |
get_bucket |
||
| Update bucket | PATCH /buckets/{bucket_id} |
admin | PlycdnStorageApi |
UpdateBucketAsync |
updateBucket |
update_bucket |
||
| Delete bucket | DELETE /buckets/{bucket_id} |
admin | PlycdnStorageApi |
DeleteBucketAsync |
deleteBucket |
delete_bucket |
||
| Restore bucket | POST /buckets/{bucket_id}/restore |
admin | PlycdnStorageApi |
RestoreBucketAsync |
restoreBucket |
restore_bucket |
||
| Retry bucket | POST /buckets/{bucket_id}/retry |
admin | PlycdnStorageApi |
RetryBucketAsync |
retryBucket |
retry_bucket |
||
| Bucket search | GET /buckets/{bucket_id}/search |
admin | PlycdnStorageApi |
GetBucketSearchAsync |
getBucketSearch |
get_bucket_search |
||
| Remove bucket from search | DELETE /buckets/{bucket_id}/search |
admin | PlycdnStorageApi |
RemoveBucketFromSearchAsync |
removeBucketFromSearch |
remove_bucket_from_search |
||
| Start upload | POST /buckets/{bucket_id}/uploads |
browser | PlycdnStorageApi |
CreateUploadAsync |
createUpload |
create_upload |
startUpload |
startUpload |
| Upload status | GET /uploads/{upload_id} |
browser | PlycdnStorageApi |
GetUploadAsync |
getUpload |
get_upload |
getUpload |
getUpload |
| Renew upload | POST /uploads/{upload_id}/renew |
browser | PlycdnStorageApi |
RenewUploadAsync |
renewUpload |
renew_upload |
renewUpload |
renewUpload |
| Complete upload | POST /uploads/{upload_id}/complete |
browser | PlycdnStorageApi |
CompleteUploadAsync |
completeUpload |
complete_upload |
completeUpload |
completeUpload |
| Abort upload | DELETE /uploads/{upload_id} |
browser | PlycdnStorageApi |
AbortUploadAsync |
abortUpload |
abort_upload |
abortUpload |
abortUpload |
| List objects | GET /buckets/{bucket_id}/objects |
browser | PlycdnStorageApi |
ListObjectsAsync |
listObjects |
list_objects |
listObjects |
listObjects |
| One object | GET /objects/{object_id} |
browser | PlycdnStorageApi |
GetObjectAsync |
getObject |
get_object |
getObject |
getObject |
| Update object | PATCH /objects/{object_id} |
admin | PlycdnStorageApi |
UpdateObjectAsync |
updateObject |
update_object |
||
| Delete object | DELETE /objects/{object_id} |
admin | PlycdnStorageApi |
DeleteObjectAsync |
deleteObject |
delete_object |
||
| Signing profile | GET /buckets/{bucket_id}/signing-profile |
admin | PlycdnStorageApi |
GetSigningProfileAsync |
getSigningProfile |
get_signing_profile |
||
| Rotate signing key | POST /buckets/{bucket_id}/signing-key/rotate |
admin | PlycdnStorageApi |
RotateSigningKeyAsync |
rotateSigningKey |
rotate_signing_key |
||
| Sign | POST /sign |
browser | PlycdnStorageApi |
SignAsync |
sign |
sign |
sign |
sign |
| Audit | GET /audit |
admin | PlycdnStorageApi |
GetAuditAsync |
getAudit |
get_audit |
||
| Purge cache | POST /buckets/{bucket_id}/purges |
admin | PlycdnStorageApi |
PurgeCacheAsync |
purgeCache |
purge_cache |
||
| Preview analytics rule | POST /buckets/{bucket_id}/analytics/preview |
admin | PlycdnStorageApi |
PreviewAnalyticsRuleAsync |
previewAnalyticsRule |
preview_analytics_rule |
||
| Storage account | GET /storage-account |
admin | PlycdnStorageApi |
GetStorageAccountAsync |
getStorageAccount |
get_storage_account |
||
| Create storage account | POST /storage-account |
admin | PlycdnStorageApi |
CreateStorageAccountAsync |
createStorageAccount |
create_storage_account |
||
| Update storage account | PATCH /storage-account |
admin | PlycdnStorageApi |
UpdateStorageAccountAsync |
updateStorageAccount |
update_storage_account |
8Custom domains, cache purges and delivery
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| Add domain | POST /domains |
admin | PlycdnStorageApi |
CreateDomainAsync |
createDomain |
create_domain |
||
| List domains | GET /domains |
admin | PlycdnStorageApi |
ListDomainsAsync |
listDomains |
list_domains |
||
| One domain | GET /domains/{domain_id} |
admin | PlycdnStorageApi |
GetDomainAsync |
getDomain |
get_domain |
||
| Delete domain | DELETE /domains/{domain_id} |
admin | PlycdnStorageApi |
DeleteDomainAsync |
deleteDomain |
delete_domain |
||
| Check domain | POST /domains/{domain_id}/check |
admin | PlycdnStorageApi |
CheckDomainAsync |
checkDomain |
check_domain |
||
| List purges | GET /purges |
admin | PlycdnStorageApi |
ListPurgesAsync |
listPurges |
list_purges |
||
| One purge | GET /purges/{purge_id} |
admin | PlycdnStorageApi |
GetPurgeAsync |
getPurge |
get_purge |
||
| Delivery analytics | GET /delivery/analytics |
admin | PlycdnStorageApi |
GetDeliveryAnalyticsAsync |
getDeliveryAnalytics |
get_delivery_analytics |
9Video libraries and videos
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| Create library | POST /libraries |
admin | PlycdnVideoApi |
CreateLibraryAsync |
createLibrary |
create_library |
||
| List libraries | GET /libraries |
admin | PlycdnVideoApi |
ListLibrariesAsync |
listLibraries |
list_libraries |
||
| One library | GET /libraries/{library_id} |
admin | PlycdnVideoApi |
GetLibraryAsync |
getLibrary |
get_library |
||
| Update library | PATCH /libraries/{library_id} |
admin | PlycdnVideoApi |
UpdateLibraryAsync |
updateLibrary |
update_library |
||
| Delete library | DELETE /libraries/{library_id} |
admin | PlycdnVideoApi |
DeleteLibraryAsync |
deleteLibrary |
delete_library |
||
| Create video | POST /libraries/{library_id}/videos |
admin | PlycdnVideoApi |
CreateVideoAsync |
createVideo |
create_video |
||
| List videos | GET /libraries/{library_id}/videos |
admin | PlycdnVideoApi |
ListVideosAsync |
listVideos |
list_videos |
||
| One video | GET /videos/{video_id} |
browser | PlycdnVideoApi |
GetVideoAsync |
getVideo |
get_video |
getVideo |
getVideo |
| Update video | PATCH /videos/{video_id} |
admin | PlycdnVideoApi |
UpdateVideoAsync |
updateVideo |
update_video |
||
| Delete video | DELETE /videos/{video_id} |
admin | PlycdnVideoApi |
DeleteVideoAsync |
deleteVideo |
delete_video |
||
| Reencode video | POST /videos/{video_id}/reencode |
admin | PlycdnVideoApi |
ReencodeVideoAsync |
reencodeVideo |
reencode_video |
||
| Start playback | POST /playback-sessions |
admin | PlycdnVideoApi |
StartPlaybackAsync |
startPlayback |
start_playback |
||
| Playback progress | GET /playback-progress |
admin | PlycdnVideoApi |
GetPlaybackProgressAsync |
getPlaybackProgress |
get_playback_progress |
||
| Reset playback progress | DELETE /playback-progress |
admin | PlycdnVideoApi |
ResetPlaybackProgressAsync |
resetPlaybackProgress |
reset_playback_progress |
||
| Create live input | POST /libraries/{library_id}/live-inputs |
admin | PlycdnVideoApi |
CreateLiveInputAsync |
createLiveInput |
create_live_input |
||
| List live inputs | GET /libraries/{library_id}/live-inputs |
admin | PlycdnVideoApi |
ListLiveInputsAsync |
listLiveInputs |
list_live_inputs |
10Webhooks
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| Create webhook | POST /webhooks |
admin | PlycdnVideoApi |
CreateWebhookAsync |
createWebhook |
create_webhook |
||
| List webhooks | GET /webhooks |
admin | PlycdnVideoApi |
ListWebhooksAsync |
listWebhooks |
list_webhooks |
||
| One webhook | GET /webhooks/{webhook_id} |
admin | PlycdnVideoApi |
GetWebhookAsync |
getWebhook |
get_webhook |
||
| Update webhook | PATCH /webhooks/{webhook_id} |
admin | PlycdnVideoApi |
UpdateWebhookAsync |
updateWebhook |
update_webhook |
||
| Delete webhook | DELETE /webhooks/{webhook_id} |
admin | PlycdnVideoApi |
DeleteWebhookAsync |
deleteWebhook |
delete_webhook |
||
| Rotate webhook secret | POST /webhooks/{webhook_id}/secret/rotate |
admin | PlycdnVideoApi |
RotateWebhookSecretAsync |
rotateWebhookSecret |
rotate_webhook_secret |
||
| Ping webhook | POST /webhooks/{webhook_id}/ping |
admin | PlycdnVideoApi |
PingWebhookAsync |
pingWebhook |
ping_webhook |
||
| Webhook deliveries | GET /webhooks/{webhook_id}/deliveries |
admin | PlycdnVideoApi |
ListWebhookDeliveriesAsync |
listWebhookDeliveries |
list_webhook_deliveries |
||
| Redeliver webhook | POST /webhook-deliveries/{delivery_id}/redeliver |
admin | PlycdnVideoApi |
RedeliverWebhookAsync |
redeliverWebhook |
redeliver_webhook |
11Live streaming
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| One live input | GET /live-inputs/{input_id} |
browser | PlycdnVideoApi |
GetLiveInputAsync |
getLiveInput |
get_live_input |
getLiveInput |
getLiveInput |
| Update live input | PATCH /live-inputs/{input_id} |
admin | PlycdnVideoApi |
UpdateLiveInputAsync |
updateLiveInput |
update_live_input |
||
| Delete live input | DELETE /live-inputs/{input_id} |
admin | PlycdnVideoApi |
DeleteLiveInputAsync |
deleteLiveInput |
delete_live_input |
||
| Rotate stream key | POST /live-inputs/{input_id}/stream-key |
admin | PlycdnVideoApi |
RotateStreamKeyAsync |
rotateStreamKey |
rotate_stream_key |
||
| Reveal stream key | GET /live-inputs/{input_id}/stream-key |
admin | PlycdnVideoApi |
RevealStreamKeyAsync |
revealStreamKey |
reveal_stream_key |
||
| Create publish token | POST /live-inputs/{input_id}/publish-tokens |
admin | PlycdnVideoApi |
CreatePublishTokenAsync |
createPublishToken |
create_publish_token |
||
| Disable live input | POST /live-inputs/{input_id}/disable |
admin | PlycdnVideoApi |
DisableLiveInputAsync |
disableLiveInput |
disable_live_input |
||
| Enable live input | POST /live-inputs/{input_id}/enable |
admin | PlycdnVideoApi |
EnableLiveInputAsync |
enableLiveInput |
enable_live_input |
||
| End live stream | POST /live-inputs/{input_id}/end |
admin | PlycdnVideoApi |
EndStreamAsync |
endStream |
end_stream |
||
| List live streams | GET /live-inputs/{input_id}/streams |
admin | PlycdnVideoApi |
ListStreamsAsync |
listStreams |
list_streams |
||
| One live stream | GET /streams/{stream_id} |
admin | PlycdnVideoApi |
GetStreamAsync |
getStream |
get_stream |
||
| Live stream captions | GET /streams/{stream_id}/captions |
browser | PlycdnVideoApi |
GetStreamCaptionsAsync |
getStreamCaptions |
get_stream_captions |
getStreamCaptions |
getStreamCaptions |
| Live stream viewers | GET /streams/{stream_id}/viewers |
admin | PlycdnVideoApi |
GetStreamViewersAsync |
getStreamViewers |
get_stream_viewers |
||
| Live stream health | GET /streams/{stream_id}/health |
admin | PlycdnVideoApi |
GetStreamHealthAsync |
getStreamHealth |
get_stream_health |
||
| Create destination | POST /live-inputs/{input_id}/destinations |
admin | PlycdnVideoApi |
CreateDestinationAsync |
createDestination |
create_destination |
||
| List destinations | GET /live-inputs/{input_id}/destinations |
admin | PlycdnVideoApi |
ListDestinationsAsync |
listDestinations |
list_destinations |
||
| Update destination | PATCH /destinations/{destination_id} |
admin | PlycdnVideoApi |
UpdateDestinationAsync |
updateDestination |
update_destination |
||
| Delete destination | DELETE /destinations/{destination_id} |
admin | PlycdnVideoApi |
DeleteDestinationAsync |
deleteDestination |
delete_destination |
||
| Test destination | POST /destinations/{destination_id}/test |
admin | PlycdnVideoApi |
TestDestinationAsync |
testDestination |
test_destination |
||
| Insert ad break | POST /live-inputs/{input_id}/breaks |
admin | PlycdnVideoApi |
InsertAdBreakAsync |
insertAdBreak |
insert_ad_break |
||
| Create share link | POST /live-inputs/{input_id}/share-links |
admin | PlycdnVideoApi |
CreateShareLinkAsync |
createShareLink |
create_share_link |
||
| List share links | GET /live-inputs/{input_id}/share-links |
admin | PlycdnVideoApi |
ListShareLinksAsync |
listShareLinks |
list_share_links |
||
| Update share link | PATCH /live-inputs/{input_id}/share-links/{link_id} |
admin | PlycdnVideoApi |
UpdateShareLinkAsync |
updateShareLink |
update_share_link |
||
| Delete share link | DELETE /live-inputs/{input_id}/share-links/{link_id} |
admin | PlycdnVideoApi |
DeleteShareLinkAsync |
deleteShareLink |
delete_share_link |
12Watch pages: brand and domains
Storage and video packages
| Task | Route | Kind | Class | ASP.NET Core | Node.js | Python | Angular | React |
|---|---|---|---|---|---|---|---|---|
| Get watch brand | GET /watch-brand |
admin | PlycdnVideoApi |
GetWatchBrandAsync |
getWatchBrand |
get_watch_brand |
||
| Set watch brand | PUT /watch-brand |
admin | PlycdnVideoApi |
UpdateWatchBrandAsync |
updateWatchBrand |
update_watch_brand |
||
| Set watch brand logo | PUT /watch-brand/logo |
admin | PlycdnVideoApi |
UploadWatchBrandLogoAsync |
uploadWatchBrandLogo |
upload_watch_brand_logo |
||
| Delete watch brand logo | DELETE /watch-brand/logo |
admin | PlycdnVideoApi |
DeleteWatchBrandLogoAsync |
deleteWatchBrandLogo |
delete_watch_brand_logo |
||
| List watch domains | GET /watch-domains |
admin | PlycdnVideoApi |
ListWatchDomainsAsync |
listWatchDomains |
list_watch_domains |
||
| Add watch domain | POST /watch-domains |
admin | PlycdnVideoApi |
AddWatchDomainAsync |
addWatchDomain |
add_watch_domain |
||
| One watch domain | GET /watch-domains/{domain_id} |
admin | PlycdnVideoApi |
GetWatchDomainAsync |
getWatchDomain |
get_watch_domain |
||
| Check watch domain now | POST /watch-domains/{domain_id}/check |
admin | PlycdnVideoApi |
CheckWatchDomainAsync |
checkWatchDomain |
check_watch_domain |
||
| Delete watch domain | DELETE /watch-domains/{domain_id} |
admin | PlycdnVideoApi |
RemoveWatchDomainAsync |
removeWatchDomain |
remove_watch_domain |
13Sub-organizations, quotas, statements and the account audit
Admin key. accountId is your account's own id. These calls are in the Content Search packages and in the storage and video packages (from 1.16.0), with the same names. Guide: Managing sub-organizations from code.
| Task | ASP.NET Core | Node.js | Python |
|---|---|---|---|
| Account audit | ListAccountAuditAsync |
listAccountAudit |
list_account_audit |
| List sub-organizations | ListSubOrganizationsAsync |
listSubOrganizations |
list_sub_organizations |
| Create sub-organization | CreateSubOrganizationAsync |
createSubOrganization |
create_sub_organization |
| One sub-organization | GetSubOrganizationAsync |
getSubOrganization |
get_sub_organization |
| Update sub-organization | UpdateSubOrganizationAsync |
updateSubOrganization |
update_sub_organization |
| Deactivate sub-organization | DeactivateSubOrganizationAsync |
deactivateSubOrganization |
deactivate_sub_organization |
| Usage quotas | GetUsageQuotasAsync |
getUsageQuotas |
get_usage_quotas |
| Organization quotas | GetOrganizationQuotasAsync |
getOrganizationQuotas |
get_organization_quotas |
| Set organization quotas | SetOrganizationQuotasAsync |
setOrganizationQuotas |
set_organization_quotas |
| List statements | ListStatementsAsync |
listStatements |
list_statements |
| One statement | GetStatementAsync |
getStatement |
get_statement |
| Export statement | ExportStatementCsvAsync |
exportStatementCsv |
export_statement_csv |
14Helpers that are not routes
These are part of the server packages too, with the same names in every language by the rules above.
| Task | ASP.NET Core | Node.js | Python |
|---|---|---|---|
| Upload bytes your server holds, with retries and resume | PlycdnUploader.UploadAsync |
PlycdnUploader.upload |
PlycdnUploader.upload |
| Carry on an upload session you already started | PlycdnUploader.ContinueUploadAsync |
PlycdnUploader.continueUpload |
PlycdnUploader.continue_upload |
| Upload a video file and create the video | PlycdnVideoUploader.UploadVideoAsync |
PlycdnVideoUploader.uploadVideo |
PlycdnVideoUploader.upload_video |
| Upload every video file of a folder, skipping the ones already added | PlycdnVideoUploader.UploadVideosAsync |
PlycdnVideoUploader.uploadVideos |
PlycdnVideoUploader.upload_videos |
Find the video a file under sources/ became |
GetVideoBySourceKeyAsync |
getVideoBySourceKey |
get_video_by_source_key |
| Sign a file link in your own process | PlycdnLinkSigner |
PlycdnLinkSigner.sign |
PlycdnLinkSigner.sign |
| Sign a video's playback links in your process | PlycdnVideoSigner.SignVideoAsync |
PlycdnVideoSigner.signVideo |
PlycdnVideoSigner.sign_video |
| Have plycdn sign a video's links (required for a protected recording) | PlycdnVideoSigner.SignVideoFromPlycdnAsync |
PlycdnVideoSigner.signVideoFromPlycdn |
PlycdnVideoSigner.sign_video_from_plycdn |
| Sign a live input's playback links | PlycdnVideoSigner.SignLiveAsync |
PlycdnVideoSigner.signLive |
PlycdnVideoSigner.sign_live |
| Verify a webhook | PlycdnWebhookVerifier.Verify and ReadAsync |
PlycdnWebhookVerifier.verify and read |
PlycdnWebhookVerifier.verify and read |
| Read the activity of one bucket, or find documents by file name | GetActivityForBucketAsync, FindDocumentsAsync |
getActivityForBucket, findDocuments |
get_activity_for_bucket, find_documents |
| Read your playback progress without naming a video | ListPlaybackProgressAsync |
listPlaybackProgress |
list_playback_progress |
| Change a bucket's search section | UpdateBucketSearchAsync |
updateBucketSearch |
update_bucket_search |
| Download the traffic breakdown as CSV | GetDeliveryBreakdownCsvAsync |
getDeliveryBreakdownCsv |
get_delivery_breakdown_csv |
| Create an S3 or Azure client for a bucket | PlycdnS3.CreateClientAsync, PlycdnBlob.CreateServiceClientAsync |
createClientFromRegions, createServiceClientFromRegions |
create_client_from_regions, create_service_client_from_regions |
Where to read more: Content Search integration, API reference, Storage, Video and webhooks, and one guide per platform: ASP.NET Core, Node.js, Python, Angular and React.