Skip to content
Tilecast Docs

Overview

Tilecast API 0.10.0

Section titled “Tilecast API 0.10.0”

Information

  • License: AGPL-3.0-only
  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/healthz
GET
/install.sh
GET
/install-airplay.sh
GET
/install/tilecast-player.service
GET
/readyz
GET
/api/v1/install/linux
GET
/api/v1/install/linux/artifact
HEAD
/api/v1/install/linux/artifact
GET
/api/v1/install/airplay/uxplay
HEAD
/api/v1/install/airplay/uxplay
GET
/api/v1/install/airplay/uxplay.sha256
GET
/api/v1/auth/status
GET
/api/v1/demo
POST
/api/v1/demo/reset
POST
/api/v1/auth/setup
POST
/api/v1/auth/login
POST
/api/v1/auth/mfa/verify
POST
/api/v1/auth/mfa/passkey/options
POST
/api/v1/auth/passkey/login/options
POST
/api/v1/auth/passkey/login
GET
/api/v1/me/security
POST
/api/v1/me/security/totp
POST
/api/v1/me/security/totp/confirm
POST
/api/v1/me/security/totp/remove
POST
/api/v1/me/security/recovery-codes
POST
/api/v1/me/security/passkeys/options
POST
/api/v1/me/security/passkeys
PATCH
/api/v1/me/security/passkeys/{id}
POST
/api/v1/me/security/passkeys/{id}/remove
POST
/api/v1/users/{id}/security/reset
DELETE
/api/v1/users/{id}/permanent
POST
/api/v1/auth/logout
GET
/api/v1/system/identity
GET
/api/v1/content-folders
POST
/api/v1/content-folders
GET
/api/v1/content-collections
POST
/api/v1/content-collections
GET
/api/v1/content-tags
POST
/api/v1/content-tags
POST
/api/v1/assets/bulk-organize
POST
/api/v1/player/pairing-sessions
GET
/api/v1/player/pairing-sessions/{id}
POST
/api/v1/player/enroll
POST
/api/v1/player/heartbeat
POST
/api/v1/player/liveness
GET
/api/v1/player/socket
GET
/api/v1/screens
GET
/api/v1/screens/{id}
PATCH
/api/v1/screens/{id}
GET
/api/v1/screens/{id}/player-history
POST
/api/v1/screens/pairing/resolve
POST
/api/v1/screens/pairing/{id}/approve
GET
/api/v1/locations
POST
/api/v1/locations
DELETE
/api/v1/locations/{id}
PATCH
/api/v1/locations/{id}
GET
/api/v1/plugins
POST
/api/v1/plugins/{pluginId}/install
DELETE
/api/v1/plugins/{pluginId}/installation
GET
/api/v1/plugins/dependency-graph
GET
/api/v1/plugins/countdown-bar/instances
POST
/api/v1/plugins/countdown-bar/instances
GET
/api/v1/plugins/countdown-bar/instances/{id}
PUT
/api/v1/plugins/countdown-bar/instances/{id}
DELETE
/api/v1/plugins/countdown-bar/instances/{id}
GET
/api/v1/plugins/brand-bug/instances
POST
/api/v1/plugins/brand-bug/instances
GET
/api/v1/plugins/brand-bug/instances/{id}
PUT
/api/v1/plugins/brand-bug/instances/{id}
DELETE
/api/v1/plugins/brand-bug/instances/{id}
GET
/api/v1/plugins/noise-meter/instances
POST
/api/v1/plugins/noise-meter/instances
GET
/api/v1/plugins/noise-meter/instances/{id}
PUT
/api/v1/plugins/noise-meter/instances/{id}
DELETE
/api/v1/plugins/noise-meter/instances/{id}
GET
/api/v1/plugins/noise-meter/instances/{id}/history/summary
GET
/api/v1/plugins/noise-meter/instances/{id}/history/series
GET
/api/v1/plugins/noise-meter/instances/{id}/history/daily
GET
/api/v1/plugins/noise-meter/instances/{id}/history/screens
GET
/api/v1/plugins/noise-meter/instances/{id}/history/export.csv
POST
/api/v1/screens/pairing/{id}/reject
POST
/api/v1/screens/{id}/disable
POST
/api/v1/screens/{id}/enable
POST
/api/v1/screens/{id}/revoke
POST
/api/v1/uploads
DELETE
/api/v1/uploads/{id}
HEAD
/api/v1/uploads/{id}
PATCH
/api/v1/uploads/{id}
POST
/api/v1/uploads/{id}/complete
GET
/api/v1/assets
POST
/api/v1/assets/archive
POST
/api/v1/assets/restore
GET
/api/v1/assets/{id}
DELETE
/api/v1/assets/{id}
PATCH
/api/v1/assets/{id}
POST
/api/v1/assets/{id}/retry
GET
/api/v1/assets/{id}/thumbnail
GET
/api/v1/assets/{id}/preview
HEAD
/api/v1/assets/{id}/preview
GET
/api/v1/player/assets/{assetId}/variants/{variantId}
HEAD
/api/v1/player/assets/{assetId}/variants/{variantId}
GET
/api/v1/playlists
POST
/api/v1/playlists
GET
/api/v1/playlists/{id}
DELETE
/api/v1/playlists/{id}
PATCH
/api/v1/playlists/{id}
POST
/api/v1/playlists/{id}/items
PUT
/api/v1/playlists/{id}/items/order
PUT
/api/v1/playlists/{id}/items/bulk
PUT
/api/v1/playlists/{id}/tag-rule
DELETE
/api/v1/playlists/{id}/items/{itemId}
PATCH
/api/v1/playlists/{id}/items/{itemId}
GET
/api/v1/screens/{id}/playlist-assignment
PUT
/api/v1/screens/{id}/playlist-assignment
DELETE
/api/v1/screens/{id}/playlist-assignment
GET
/api/v1/player/manifest
GET
/api/v1/player/span-panels/{id}
HEAD
/api/v1/player/span-panels/{id}
GET
/api/v1/screen-groups
POST
/api/v1/screen-groups
GET
/api/v1/screen-groups/{id}
DELETE
/api/v1/screen-groups/{id}
PATCH
/api/v1/screen-groups/{id}
GET
/api/v1/screen-groups/{id}/span
PUT
/api/v1/screen-groups/{id}/span
GET
/api/v1/screen-groups/{id}/display-control/preview
POST
/api/v1/screen-groups/{id}/display-control
POST
/api/v1/screen-groups/{id}/screens
DELETE
/api/v1/screen-groups/{id}/screens/{screenId}
PUT
/api/v1/screen-groups/{id}/playlist-assignment
DELETE
/api/v1/screen-groups/{id}/playlist-assignment
GET
/api/v1/schedules
POST
/api/v1/schedules
GET
/api/v1/schedules/{id}
DELETE
/api/v1/schedules/{id}
PATCH
/api/v1/schedules/{id}
POST
/api/v1/schedules/{id}/enable
POST
/api/v1/schedules/{id}/disable
POST
/api/v1/schedules/preview
POST
/api/v1/assets/websites
PATCH
/api/v1/assets/{id}/website
GET
/api/v1/assets/{id}/website/diagnostics
POST
/api/v1/widgets
GET
/api/v1/provider-catalog
GET
/api/v1/content-definitions
POST
/api/v1/widgets/compile-preview
PATCH
/api/v1/widgets/{id}
PUT
/api/v1/widgets/{id}/preview-image
POST
/api/v1/widgets/{id}/duplicate
GET
/api/v1/data-sources
POST
/api/v1/data-sources
GET
/api/v1/data-sources/{id}
DELETE
/api/v1/data-sources/{id}
PATCH
/api/v1/data-sources/{id}
POST
/api/v1/data-sources/{id}/duplicate
GET
/api/v1/data-sources/{id}/diagnostics
POST
/api/v1/data-sources/{provider}/preview
GET
/api/v1/data-sources/{id}/inspect
POST
/api/v1/data-sources/{provider}/inspect
GET
/api/v1/forms
POST
/api/v1/forms
GET
/api/v1/data-sources/{id}/form
PATCH
/api/v1/data-sources/{id}/form
PATCH
/api/v1/data-sources/{id}/form/draft
POST
/api/v1/data-sources/{id}/form/publish
PUT
/api/v1/data-sources/{id}/form/workflow
GET
/api/v1/data-sources/{id}/records
POST
/api/v1/data-sources/{id}/records
GET
/api/v1/data-sources/{id}/records/{recordId}
DELETE
/api/v1/data-sources/{id}/records/{recordId}
PATCH
/api/v1/data-sources/{id}/records/{recordId}
POST
/api/v1/data-sources/{id}/records/{recordId}/transitions
POST
/api/v1/data-sources/{id}/records/{recordId}/comments
POST
/api/v1/data-sources/{id}/records/{recordId}/attachments
DELETE
/api/v1/data-sources/{id}/records/{recordId}/attachments/{attachmentId}
GET
/api/v1/data-sources/{id}/records/{recordId}/attachments/{attachmentId}/content
GET
/api/v1/approvals
POST
/api/v1/data-sources/{id}/views/preview
GET
/api/v1/data-sources/{id}/outputs
POST
/api/v1/data-sources/{id}/outputs/rebuild
GET
/api/v1/data-sources/{id}/access
PUT
/api/v1/data-sources/{id}/access/{userId}
GET
/api/v1/data-sources/{id}/user-directory
GET
/api/v1/layouts
POST
/api/v1/layouts
GET
/api/v1/layouts/{id}
DELETE
/api/v1/layouts/{id}
PATCH
/api/v1/layouts/{id}
PUT
/api/v1/layouts/{id}/draft
GET
/api/v1/layouts/{id}/preview-image
PUT
/api/v1/layouts/{id}/preview-image
POST
/api/v1/layouts/{id}/publish
POST
/api/v1/layouts/{id}/duplicate
GET
/api/v1/layouts/{id}/revisions
POST
/api/v1/layouts/{id}/revisions/{revisionId}/restore
GET
/api/v1/content-submissions
GET
/api/v1/content-submissions/{id}
POST
/api/v1/content-submissions/{type}/{id}
POST
/api/v1/content-submissions/{id}/approve
POST
/api/v1/content-submissions/{id}/request-changes
POST
/api/v1/content-submissions/{id}/publish
POST
/api/v1/content-submissions/{id}/schedule
POST
/api/v1/content-submissions/{id}/cancel-schedule
GET
/api/v1/content-history/{type}/{id}/publications
GET
/api/v1/content-history/{type}/{id}/compare
POST
/api/v1/content-history/{type}/{id}/publications/{publicationId}/restore-draft
POST
/api/v1/content-history/{type}/{id}/publications/{publicationId}/rollback
GET
/api/v1/campaigns
POST
/api/v1/campaigns
GET
/api/v1/campaigns/{id}
DELETE
/api/v1/campaigns/{id}
PATCH
/api/v1/campaigns/{id}/draft
GET
/api/v1/campaigns/{id}/preflight
GET
/api/v1/campaigns/{id}/releases
POST
/api/v1/campaigns/{id}/releases/{releaseId}/restore
POST
/api/v1/campaigns/{id}/publish
GET
/api/v1/takeovers
POST
/api/v1/takeovers
GET
/api/v1/takeovers/{id}
POST
/api/v1/takeovers/{id}/cancel
GET
/api/v1/presentation-networks
POST
/api/v1/presentation-networks
GET
/api/v1/presentation-networks/{id}
DELETE
/api/v1/presentation-networks/{id}
PATCH
/api/v1/presentation-networks/{id}
PUT
/api/v1/presentation-networks/{id}/screens
POST
/api/v1/presentation-networks/{id}/test
GET
/api/v1/screens/{id}/presentation-network
PUT
/api/v1/screens/{id}/presentation-network
DELETE
/api/v1/screens/{id}/presentation-network
GET
/api/v1/player/presentation-network
GET
/api/v1/presentation-overrides
POST
/api/v1/presentation-overrides
POST
/api/v1/presentation-overrides/{id}/stop
GET
/api/v1/alerts/nws
GET
/api/v1/alerts/nws/zones
PUT
/api/v1/alerts/nws/monitor
POST
/api/v1/alerts/nws/poll
POST
/api/v1/alerts/nws/rules
PUT
/api/v1/alerts/nws/rules/{id}
DELETE
/api/v1/alerts/nws/rules/{id}
GET
/api/v1/screens/{id}/commands
POST
/api/v1/screens/{id}/commands
GET
/api/v1/player/commands
POST
/api/v1/player/commands/{id}/acknowledge
POST
/api/v1/player/commands/{id}/result
GET
/api/v1/settings
PATCH
/api/v1/settings
GET
/api/v1/me/preferences
PATCH
/api/v1/me/preferences
GET
/api/v1/screen-groups/{id}/policy
PUT
/api/v1/screen-groups/{id}/policy
DELETE
/api/v1/screen-groups/{id}/policy
GET
/api/v1/screens/{id}/policy
PUT
/api/v1/screens/{id}/policy
DELETE
/api/v1/screens/{id}/policy
GET
/api/v1/screens/{id}/effective-policy
GET
/api/v1/screens/{id}/reliability
PUT
/api/v1/screens/{id}/power-assist
GET
/api/v1/player/config
GET
/api/v1/system/status
POST
/api/v1/system/maintenance/{action}
GET
/api/v1/system/settings/export
POST
/api/v1/system/settings/import/preview
POST
/api/v1/system/settings/import/apply
GET
/api/v1/player-releases
POST
/api/v1/player-releases/check
POST
/api/v1/player-releases/github/device
POST
/api/v1/player-releases/github/device/poll
DELETE
/api/v1/player-releases/github
POST
/api/v1/player-releases/upload
POST
/api/v1/player-releases/{id}/cache
GET
/api/v1/update-deployments
POST
/api/v1/update-deployments
GET
/api/v1/update-deployments/{id}
POST
/api/v1/update-deployments/{id}/cancel
POST
/api/v1/update-deployments/{id}/screens/{screenId}/retry
GET
/api/v1/player/updates/{releaseId}
GET
/api/v1/player/updates/{releaseId}/apk
HEAD
/api/v1/player/updates/{releaseId}/apk
POST
/api/v1/player/update-deployments/{deploymentId}/status

Authentication

Section titled “ Authentication ”

deviceBearer

Section titled “deviceBearer”

Security scheme type: http

Bearer format: Tilecast device credential