1. Distributions
vidinfra
  • Default module
    • Documentation
      • Guides
        • Welcome
        • Getting Started
          • What is Vidinfra?
          • Quick Start Guide
          • Publish First Video
          • FAQs
        • Upload & Import Videos
          • Upload from Device
          • Import from Vimeo
          • Import from YouTube
          • Import from Zoom
        • DRM
          • Widevine DRM
          • FairPlay DRM
        • Accounts
          • Accounts
        • Organization Settings
          • User Management
          • Billing
          • Settings
    • API Reference
      • Admin
        • User
          • Create User
          • Find Users
          • Update User Password
          • Login as Customer
          • Show User details
          • Show User Session
          • Delete User Sessions
          • Verify User Email
        • Organization
          • List organizations
          • Get an organization
        • Profile
          • Update Password
      • Auth
        • User Registration
        • User Login
        • Verify-email
        • Forgot Password
        • Forgot Password Verify OTP
        • Forgot Password Set
        • Resend OTP
        • Logout
        • Set Password
        • Check Account exists
        • Update Password
        • Google Oauth Redirect
        • Google Oauth Callback
        • api-access-check
        • New Auth token using Refresh token
        • Github Oauth Redirect
        • Google Oauth Callback Copy
        • Get User Sessions
        • Delete User Sessions
      • User
        • me
        • Profile Updates
        • DEL User
        • Profile Avatar update
        • Permission Details
        • Old Permission Details
      • Libraries
        • Get Library List
        • Get Library Details
        • Create New Library
        • Destory Library
        • Update Library
        • Update Logo
        • Get Library Settings
        • Upsert Library Settings
      • Organization
        • Delete a Organization
        • List organizations
        • Create an organization
        • Get an organization
        • Update an organization
        • Switch an organization
      • Organization's invitations
        • Sent invitation list
        • Send invitation
        • Resend Invitation
        • Show Token
        • Accept Invitation
        • Reject Invitation
        • Cancel Invitation
      • Members
        • Members
        • Remove Member
        • test permission
        • Update Member Permission
      • Billings
        • Wallet
          • Get Wallet Trnxs
          • Get Wallet
          • Wallet Transaction
          • Update Wallet
          • Get Trnx Details
        • Self
          • Get Org's Billing Overview
          • Get Organization's Billing Info
          • Billing Usage of Org
          • Delete Org Payment Method
          • Update Billing Info
          • Set Org Default Payment Method
          • Payment Methods
          • Billing Usage of Org Copy
        • Plans
          • List Plans
          • Get A Plan
        • Subscription
          • Get Subscriptions
          • Subscribe to a Plan
          • Upgrade a Subscription
          • Get Current Active Subscription
          • Get A Subscription Details
          • Update A Subscription
          • Cancel A Subscription
          • Resume A Subscription
          • Pause A Subscription
          • Cancellation Reasons
          • Subscription Entitlements
        • Invoice
          • List Invoice
          • Get An Invoice
          • Download An Invoice PDF
        • VATs
          • Index VATs
        • Coupon
          • List Coupon
          • Get A Coupon
          • Create A Coupon
          • Update A Coupon
          • Delete A Coupon
          • Get Coupon by Name
      • Audits
        • Audits
      • API Keys
        • Get All API keys
        • Get API Key
        • Create API Keys
        • Destory API Keys
        • api key middleware (test)
      • Folders
        • Get All Folders
        • Create Folder
        • Get Folder by ID
        • Update Folder
        • Move Folder
        • Bulk Move Folders (empty)
        • Delete Folder
        • Get Folder Tree
      • Videos
        • Get All video of a library
        • Get a Video
        • Get Video using Custom field
        • create video
        • Upload thumbnail
        • Update video
        • Destroy video
        • Search Video
        • batch video Assign to collecition
        • Mark Thumbnail As Default
        • Get Video Timelines
      • Audios
        • Get audios
        • Get a Audio
        • Get Audio using Custom field
        • Audio Create
        • Upload thumbnail
        • Update Audio
        • Destroy Audio
        • Search Audio
        • batch Audio Assign to collecition
        • Mark Thumbnail As Default
        • Get Video Timelines
      • Video Metas
        • Create or Update Video Meta Data
        • Get All Meta Data of a Video
      • Video Captions
        • create video caption
        • Delete a video Caption
        • Get video caption
      • Video Chapter
        • create video chapters
      • Uploads
      • Tags
        • Get all tags upder a project
        • Create Tag
        • Delete tag
      • Players
        • Get all Players
        • Create Player
        • Get Specific player
        • update player
        • Delete Player
        • Player Mark as default
      • Webhook Endpoints
        • Get webhook
        • Create web hook
        • GET Webhook by ID
        • Update webhook
        • Delete web hook
      • Advertisements
        • Get all ads
        • Create ads
        • Get single advertisement
        • Update ads
        • Delete ads
      • Migrate
        • welcome
        • Debug
        • test
      • Webhook Event Logs
        • Get webhook event logs
        • Resend Webhook event by Id
        • Resend All Webhook Event
      • Analytics Direct Api
        • geo-distribution
        • Project Views
        • avg video watch
        • Total watch Time
        • Project Avg Watch per Unique user
        • Total Player Error
        • project popularity-analysis
        • Project Collection Insights
        • Collection Views
        • Collection avg Watch time
        • Collection Avg Watch per unique user
        • Collection Geo Distribution
        • Get all Users
        • User media views
        • User Avg video watch
        • user Player log
        • user sessions
        • Get all Video
        • video Player error
        • Video View
        • video Geo Distribution
        • video Avg watch
        • copy
      • Streams
        • Create livestream
        • Get all stream
        • Get a livestream
        • update status of livestream
        • delete a stream
        • get livestream historys
      • Stream Metas
      • Usages
        • Bandwidth Usage
        • Storage Usage
        • Get Over Usage
      • Encoding profile
        • Get all profiles
        • Create profile
        • Get A profile
        • Update a encoding profile
        • Delete a encoding profile
        • Make a profile default
      • Library Matrics
        • Admin
        • Get Matrics
        • project Usages
      • Access Control
        • Put Access Control
        • Get access Control
      • Analytics
        • Library Get geo-distribution
        • Library views
        • Library avg video watch
        • Project Total Watch
        • Library Avg Watch per Unique user
        • Library All Player Errors
        • Library Popularity Analysis
        • Library Collections insights
        • Collection Geo Distribution
        • Collection avg watch time
        • Collection avg watch per unique User
        • Collection Player error
        • Video Geo Distribution
        • Video views
        • Video Avg Watch
        • Video Player Log
        • User
        • User Avg Video Watch
        • User Total Watch
        • User player error log
      • Plan
        • public plans
        • current plan
        • Account Plans
        • Get plan by ID
        • Admin Get Plans
        • Admin Create plan
        • Admin Get Plan by ID
        • Admin Update Plan by ID
        • Admin Delete plan By ID
        • Admin Get Plan Metrices
        • Admin Get Plan Metrices By Type
        • Admin Create Plan Matrices By Type
        • Admin Update Plan Metrices By ID
      • Upload Tokens
        • Obtain credentials before upload
      • subscribe
        • stripe redirect subscription
          • create checkout session
          • over usage payment
        • current subscription
        • discribe a plan by planCode
        • subscribe
        • cancel subscription
        • over usage payment
        • Stripe over usage autopay payment (test)
      • Transaction
        • Get All Transaction
      • Invoice
        • Get All Invoices
        • Get Invoice by ID
      • vimeo video importer
        • vimeo job list
        • Vimeo videos by migration id
        • Vimeo Set video importer
        • Vimeo sync import
        • Vimeo import videos
        • Get pull videos
        • pull video from url
      • test
        • Welcome to vidinfra Copy
        • metrics
      • transcoding service
        • Get job details
        • Create transcoding job
        • List jobs
        • Update a job
        • Delete a job
        • create job v2
      • transcoding service v2
        • create jobs
        • get all jobs
        • get a job
        • Update a job
        • Delete a job
      • User
      • Welcome to vidinfra
      • health check
      • Regions List
      • key
    • Account Service -- (Clean up)
      • Admin
        • User
          • Create User
          • Find Users
          • Update User Password
          • Login as Customer
          • Show User details
          • Show User Session
          • Delete User Sessions
          • Verify User Email
        • Organization
          • List organizations
          • Get an organization
        • Profile
          • Update Password
        • Members
          • Members
          • Remove Member
          • test permission
          • Update Member Permission
      • Auth
        • User Registration
        • User Login
        • Verify-email
        • Forgot Password
        • Forgot Password Verify OTP
        • Forgot Password Set
        • Resend OTP
        • Logout
        • Set Password
        • Check Account exists
        • Update Password
        • Google Oauth Redirect
        • Google Oauth Callback
        • api-access-check
        • New Auth token using Refresh token
        • Github Oauth Redirect
        • Google Oauth Callback Copy
        • Get User Sessions
        • Delete User Sessions
      • User
        • me
        • Profile Updates
        • DEL User
        • Profile Avatar update
        • Permission Details
        • Permission Map
        • Old Permission Details
      • Organization
        • Delete a Organization
        • List organizations
        • Create an organization
        • Get an organization
        • Update an organization
        • Switch an organization
      • Organization's invitations
        • Send invitation
        • Resend Invitation
        • Show Token
        • Sent invitation list
        • Accept Invitation
        • Reject Invitation
        • Cancel Invitation
      • Members
        • Members
        • Remove Member
        • test permission
        • Update Member Permission
      • Billings
        • Wallet
          • Get Wallet Trnxs
          • Get Wallet
          • Wallet Transaction
          • Update Wallet
          • Get Trnx Details
        • Self
          • Get Org's Billing Overview
          • Get Organization's Billing Info
          • Billing Usage of Org
          • Delete Org Payment Method
          • Update Billing Info
          • Set Org Default Payment Method
          • Payment Methods
        • Plans
          • List Plans
          • Get A Plan
        • Subscription
          • Get Subscriptions
          • Subscribe to a Plan
          • Upgrade a Subscription
          • Get Current Active Subscription
          • Get A Subscription Details
          • Update A Subscription
          • Cancel A Subscription
          • Resume A Subscription
          • Pause A Subscription
          • Cancellation Reasons
          • Subscription Entitlements
        • Invoice
          • List Invoice
          • Get An Invoice
          • Download An Invoice PDF
        • VATs
          • Index VATs
        • Coupon
          • List Coupon
          • Get A Coupon
          • Create A Coupon
          • Update A Coupon
          • Delete A Coupon
          • Get Coupon by Name
      • Audits
        • Audits
      • API Keys
        • Get All API keys
        • Get API Key
        • Create API Keys
        • Destory API Keys
        • api key middleware (test)
      • health check
      • Regions List
      • key
    • CDN
      • Admin
        • Distributions
          • Get Distribution List
          • Get A Distribution Details
          • Delete Distribution List
          • Update Distribution Status
          • Get A Distribution Usage
        • SSL Certificate Manage
          • Get List Certificates
          • Get Certificate
          • Delete Certificate
          • Create New SSL
        • Constellix Zone
          • Update Constellix
          • Get Constellix zone
          • Delete Constellix
          • Get List Constellix
          • Create Constellix
        • Dns Record Zone
          • Update Dns record
          • Get Dns record
          • Delete Dns record
          • Get List Dns record
          • Create Dns Record zone
        • Usages
          • Traffic usages routes
      • Distributions
        • Patch Distribution
          PATCH
        • CDN Distribution API – Create Distribution
          POST
        • Update A Distribution
          PUT
        • Get Distribution Count
          GET
        • Get Distribution Stats
          GET
        • Get Distribution List
          GET
        • Delete Distribution
          DELETE
        • Get A Distribution Details
          GET
        • revoke-ssl
          PATCH
        • Toggle WebP
          PATCH
        • Assign Certificate To Distribution
          PUT
      • SSL Certificate Manage
        • Get Certificate
        • Get Certificate Stats
        • Delete Certificate
        • Request For Let's Encrypt SSL
        • Get List Certificates
        • Create New SSL
      • Origins/Upstreams Manage
        • Create Origins
        • Get Origins LIst
      • Purge
        • Create Purge
      • Prefetch
        • Create Prefetch
      • Cache Rules
        • Create Cache Rules
        • Cache Rules List
        • Cache Rules Details
        • Cache Rules Delete
        • Cache Rules update
      • Access Rules
        • Create New Access
        • Update
        • Access Rules List
        • Access Rules Details
        • Access Rules Details Copy
      • Analytics
        • analytics
      • Https Headers
        • Https Headers
        • Get Headers
      • Verificatins
        • Validate distribution cname endpoin
        • Validate Accme DNS challenge endpoint
    • Billing
      • Plans
        • List Plans
      • Billable Metrics
      • Pricing Rules
      • Usage Metrics
      • Charge Models
      • Pricing Tiers
      • Wallet
      • Invoices
      • Audit Logs
      • Add-Ons
      • Events
        • Ingest
          • Ingest Single Event
          • Ingest Bulk Event
        • List Events
      • Flexprice
    • WebP Edge
      • Upsert Host Site
      • List Host Sites
      • Delete Proxy Host
      • Chorki WebP Check
      • Chaldal WebP Check
      • G&G WebP Check
    • Vidinfra
      • Library
        • Create Library
        • Get Library Details
        • Update Library
        • Delete Library
        • List Libraries
        • Library Metrics
      • Folder
        • Create Folder
        • Get Folder Details
        • Update Folder
        • Delete Folder
        • List Folders
        • Move Folder
        • Bulk Move Folder
        • Bulk Delete Folder
      • Video
        • Create Video
        • Get Video Details
        • Update Video
        • Delete Video
        • List Videos
        • Get Video By Custom ID
        • Search Videos
        • Bulk Move Videos to Folder
        • Pull Video
        • Video Timelines
        • Restore Deleted Video
        • Bulk Restore Deleted Video
        • Bulk Delete Videos
        • Generate Token
        • Upload video
      • Subtitle
        • Create Subtitle
        • Get Subtitle
        • Update Subtitle
        • Delete Subtitle
        • List Subtitle
      • Video Thumbnails
        • Upload Thumbnail
        • Delete Thumbnail
        • Set Thumbnail
      • Transcoding Profiles
        • Create Transcoding Profile
        • List Transcoding Profiles
        • Get Transcoding Profile
        • Update Transcoding Profile
        • Mark Default Transcoding Profile
        • Delete Transcoding Profile
      • Player Themes
        • Create Player
        • Player Details
        • Update Player
        • Delete Player
        • List Players Themes
        • Mark Player As Default
      • Video Chapter
        • Upsert Chapter
        • List Chapter
      • Webhook Endpoints
        • Create Webhook Endpoint
        • List Webhook Endpoints
        • Get Webhook Endpoint by ID
        • Update Webhook Endpoint
        • Delete Webhook Endpoint
      • Webhook Deliveries
        • Get a Single Delivery
        • Retry a Webhook Delivery
        • List Deliveries for a Specific Endpoint
      • Security
        • Get Security Settings
        • Update Security Settings
      • Video Multipart Upload
        • Initialize Multipart Upload
        • Get Part Upload URL
        • List Uploaded Parts
        • Complete Multipart Upload
        • Abort Multipart Upload
      • Internals
        • Get Library by ID
        • Get Player Details
        • Video detais
        • Upsert Folder by external service API
        • Upsert Video by external service API
        • Pull Video
      • Webhook
        • Transcoding Webhook
      • Migration Jobs
        • Create Migrations
        • Validate Credentials
      • Admin
        • Library
          • List Libraries
          • Get Library Details
          • Update Library
          • Delete Library
        • Video
          • List Videos
          • Get Video Details
        • Usages
          • Usages
        • Library Pool
          • Library Pool
        • Organizations
          • Organizations
      • Audios
        • List Audios
        • Create Audio
      • flexprice sign up
      • flexprice user get
      • flexprice login
      • flexprice user get Copy
    • experiment
      • flexprice
        • Customer
          • Get a customer
          • Get customer
          • Create Customer
          • Delete Customer
          • Set default payment method
          • Delete payment method
          • Get customer invoice
          • Get customer wallet
          • Get a customer saved payment method
          • Get payment method details
          • Update Customer
        • Payment
          • Delete Payment
          • Make Payment
        • Wallet
          • Get a wallet
          • Get a realtime wallet
          • Update wallet
        • Plan
          • Delete Plan
          • Get a Plan
        • Feature
          • List features
          • List features by ID
          • Delete Feature
        • Subscription
          • List Subscription
          • Get a Subscription
          • Cancel a Subscription
          • Pause a Subscription
        • Ingest event
        • Delete Addon
        • Delete Coupon
        • Get an invoice
    • Vidinfra Ingest
      • Migrations
        • Get Migration List
        • Create Migration Job
        • Get Migration Details
        • Update a Migration Job
        • Get Logs of a Migration
        • Get WebHooks of a Migration
        • Update a Migration Status
        • Del a Migration
        • Start a Migration
        • Cred Validation
        • Migration Job List By Library with Filter
        • Mark Videos Downloadable
      • Videos
        • Get Video Jobs
        • Get a Video Job Details
        • Create a Video Job
        • Update a Video Job Details
        • Delete A Video Job
        • Get a Video Logs
        • Update a Video Job Status
      • Logs
        • Get Recent Logs
      • Webhooks
        • Get All Webhooks
        • Get Webhooks Details
        • Mark a Webhook Sent
      • Ping Api
    • Vidinfra KMS
      • Get Key
      • Create Key
      • Delete Key
    • Vidinfra Transcoding
      • Create Job
      • List Jobs
      • Delete
    • HLS Download
      • Create HLS Migrations Job
      • Get HLS Migrations Jobs
    • WebP Edge Admin
      • Cluster
        • Cluster Details
        • Cluster List
        • Create Cluster
        • Update A Cluster
        • DEL a Cluster
      • Sites
        • Site List
        • Create Site
        • Site Details
        • Del a Site
        • Update a Site
      • Health
    • Tenbyte Proxy
      • Image Proxy
        • Get Host List
        • Get A Host Details
        • Create A Host
        • Create A Host S3
        • Update A Host
        • Create Bulk Host
        • Delete Host
    • Tenbyte Replica
      • Get Jobs
      • Create Jobs
    • Draco API
      • Public
        • Create Job
        • Delete Job
        • Get Job Details
        • Cancel Job
        • Get Job Status
        • Get Job Timeline
      • Admin
        • Worker
          • Register Worker Node
          • List Workers
          • Register Worker Capability
          • List Worker Pools
        • Task
          • List Tasks
        • Job
          • List Jobs
          • Get Job Details
          • Cancel Job
          • Delete Job
        • Log and Event
          • List System Logs
          • Get System Logs Details
          • List System Events
        • Webhook
          • List Webhooks
          • Get Webhook Details
        • Scaling Rule
          • Create Scaling Rule
          • List Scaling Rules
          • Get Scaling Rule Details
          • Update Scaling Rule
          • Delete Scaling Rule
          • List Scaling History
        • Cloud Provider
          • Create Cloud Provider
          • List Cloud Providers
          • Get Cloud Provider
          • Delete Cloud Provider
          • Update Cloud Provider
        • Encoding Preset
          • Create Encoding Preset
          • List Encoding Presets
          • Get Encoding Presets
          • Update Encoding Preset
        • Others
          • Get Metrics
          • Get Overview
        • Internal
          • Job
            • Get Job Details
            • Update Job
            • Update Job Output
            • Create Job Event
            • Create Job Statistics
            • Update Job Statistics
          • Worker
            • Assign Worker to Job
            • List Worker Machines
            • List Worker Capability
    • Coupon
      • List Coupon
      • Get A Coupon
      • Create A Coupon
      • Update A Coupon
      • Delete A Coupon
      • Get Coupon by Name
    • Audios
      • Get audios
      • Get a Audio
      • Get Audio using Custom field
      • Audio Create
      • Upload thumbnail
      • Update Audio
      • Destroy Audio
      • Search Audio
      • batch Audio Assign to collecition
      • Mark Thumbnail As Default
      • Get Video Timelines
    • Root
      • Upgrade a Subscription
      • Get Current Active Subscription
      • Get A Subscription Details
      • Update A Subscription
      • Cancel A Subscription
      • Resume A Subscription
      • Pause A Subscription
      • Cancellation Reasons
      • Subscription Entitlements
      • List Invoice
      • Get An Invoice
      • Download An Invoice PDF
      • Index VATs
    • Activity Log
      • Admin
        • List Activities
        • Get Activity
      • User
        • List Activities
        • Get Activity
    • flexprice-sslcommerz payment
      POST
    • Schemas
      • Schemas
        • WorkerRegisterRequest
        • WorkerHeartbeatRequest
        • WorkerMachine
        • WorkerCapabilityCreateRequest
        • WorkerCapability
        • JobCreateRequest
        • Job
        • JobProgressUpdate
        • JobCompleteRequest
        • JobFailRequest
        • AssignWorkerRequest
  • VidInfra Live API
    • Rooms
      • List all rooms (public)
      • Create a new room
      • List my rooms
      • Get room by ID (public)
      • Update a room
      • Delete a room
    • Sessions
      • List sessions for a room
      • Create a new session in a room
      • List all sessions (public)
      • List currently live sessions (public)
      • Get dashboard stats
      • Get session by ID (public)
      • Delete a session
      • Join a session (get LiveKit token)
      • Go live with a session
      • Ensure HLS egress is running
      • Start a session
      • Start webcam to HLS streaming
      • End a session
      • Reschedule a session
      • Update session runtime settings
      • Broadcast host video state change
      • Broadcast host audio state change
      • Get monitor token for a session
      • Get stream health info
      • Generate studio URL
      • Get shareable URLs for a session
    • Auth
      • Login with email and password
      • Refresh access token
      • Register a new viewer with device token
      • Login with device token
      • Exchange auth code for tokens
      • Get current authenticated user
      • Logout and invalidate refresh token
      • Generate a short-lived auth code
    • Reminders
      • Subscribe to room reminders
      • Unsubscribe from room reminders
      • Get my reminder subscription status
    • Attendance
      • Leave a session
      • Get active viewers for a session
      • Get full attendance list
      • Get attendance statistics
      • Export attendance data
    • Participants
      • Get session participants (co-hosts, moderators)
      • Add a co-host to a session
      • Remove a co-host from a session
      • Add a moderator to a session
      • Remove a moderator from a session
    • Presets
      • Create a new preset
      • List my presets
      • Get preset by ID
      • Update a preset
      • Delete a preset
      • Set preset as default
    • Polls
      • Get polls for a session
      • Create a poll for a session
      • Vote on a poll
      • Get poll results
      • Close a poll
    • Chat
      • Get chat messages for a session
      • Send a chat message
      • Delete a chat message
    • Stage
      • Raise hand to request stage access
      • Lower hand
      • Get my hand raise status
      • Get current stage participants
      • Leave the stage
      • Get a stage token for LiveKit
      • Create a join request
      • Get my join request status
    • Stage Management
      • Add participant to stage
      • Remove participant from stage
      • Update stage participant permissions
      • Get pending join requests
      • Approve a join request
      • Reject a join request
      • Get pending hand raises
      • Approve a hand raise
      • Reject a hand raise
    • Moderation
      • Ban a participant
      • Unban a participant
      • Get banned participants list
      • Check if current user is banned
    • Recordings
      • Get my recordings
      • Get recording by ID
      • Update recording metadata
      • Delete a recording
      • Get recording download URL
      • Serve recording file (public, with token)
      • Get recordings for a session
      • Get active recording for a session
      • Start recording a session
      • Stop recording a session
    • Admin
      • Get storage status
      • Trigger storage cleanup
      • Retry a failed recording
    • Webhooks
      • LiveKit webhook handler
    • Centrifugo
      • Centrifugo connect proxy
      • Centrifugo subscribe proxy
    • Library-Scoped
      • List rooms in a library
      • Create a room in a library
      • List my rooms in a library
      • Get room by ID in a library
      • Update a room in a library
      • Delete a room in a library
      • List sessions for a room in a library
      • Create a session in a room in a library
      • Create a preset in a library
      • List my presets in a library
      • Get preset by ID in a library
      • Update a preset in a library
      • Delete a preset in a library
      • Set preset as default in a library
      • List all sessions in a library
      • List currently live sessions in a library
      • Get dashboard stats for a library
      • Subscribe to room reminders in a library
      • Unsubscribe from room reminders in a library
      • Get my reminder subscription status in a library
      • Get session by ID in a library
      • Delete a session in a library
      • Join a session in a library
      • Generate studio URL for a session in a library
      • Get shareable URLs for a session in a library
      • Go live with a session in a library
      • Ensure HLS egress is running in a library
      • Start a session in a library
      • Start webcam to HLS in a library
      • End a session in a library
      • Reschedule a session in a library
      • Get monitor token in a library
      • Get stream health in a library
      • Broadcast host video state in a library
      • Broadcast host audio state in a library
      • Get attendance list in a library
      • Get attendance stats in a library
      • Export attendance in a library
      • Generate auth code in a library
    • Health
      • Health check
    • Schemas
      • SuccessResponse
      • ErrorResponse
      • LoginRequest
      • RefreshTokenRequest
      • LogoutRequest
      • ViewerRegisterRequest
      • DeviceLoginRequest
      • GenerateAuthCodeRequest
      • ExchangeAuthCodeRequest
      • UserResponse
      • AuthResponse
      • ViewerRegisterResponse
      • GenerateAuthCodeResponse
      • CreateRoomRequest
      • UpdateRoomRequest
      • RoomAnalytics
      • RoomResponse
      • RoomListResponse
      • CreateSessionRequest
      • RescheduleSessionRequest
      • UpdateSessionSettingsRequest
      • SessionResponse
      • CreateSessionResponse
      • StartSessionResponse
      • StudioURLResponse
      • ShareURLResponse
      • JoinSessionResponse
      • SessionListResponse
      • DashboardStatsResponse
      • CreatePresetRequest
      • UpdatePresetRequest
      • PresetResponse
      • CreatePollRequest
      • VoteRequest
      • PollOptionResponse
      • PollResponse
      • PollListResponse
      • CreateChatMessageRequest
      • ChatMessageResponse
      • ChatMessagesResponse
      • RaiseHandRequest
      • HandRaiseResponse
      • JoinRequestResponse
      • AddToStageRequest
      • StageParticipantResponse
      • UpdateStagePermissionsRequest
      • RemoveFromStageRequest
      • UpdateRecordingRequest
      • RecordingResponse
      • RecordingListResponse
      • RecordingDownloadResponse
      • AttendanceResponse
      • AttendanceListResponse
      • AttendanceStatsResponse
      • ActiveViewerResponse
      • ActiveViewersResponse
      • BanParticipantRequest
      • BannedParticipantResponse
      • BannedParticipantsListResponse
      • AddParticipantRoleRequest
      • SessionParticipantResponse
      • SessionParticipantsListResponse
  1. Distributions

Get Distribution List

GET
/distributions

📦 Distributions API Documentation#

Endpoint#

GET /v1/distributions

Query Parameters#

📑 Pagination#


Parameter Type Description

page number Page number (default: 1)

limit number Number of items per page (default: 15, min: 1, max: 50)#


🔍 Filtering#

You can filter by the following fields:
id
name
cname
domain
status
domain_type
cache_strategy
organization_id
certificate_id
enable_ssl
is_redirect_http_to_https
is_http2
is_http3
is_cname_valid
is_acme_challenge_valid
le_issue
created_at
updated_at

Operators#

Operator Description

eq Equals
ne Not equals
like Contains (case insensitive)
not-like Does not contain
starts-with Starts with
ends-with Ends with
gt Greater than
gte Greater than or equal
lt Less than
lte Less than or equal
in In list (comma-separated)
not-in Not in list
null Is null
not-null Is not null
between Between two values (comma-separated)
not-between Not between two values (comma-separated)

Example Filters#

filter[name][starts-with]=cdn-
filter[status][in]=active,disabled
filter[enable_ssl][eq]=true
filter[created_at][between]=2025-01-01,2025-08-01

↕ Sorting#


Parameter Description

sort Sort fields. Prefix with - for descending. Allowed:
created_at, updated_at, name, status, domain_type,
cache_strategy, domain, cname

Example Sorts#

sort=-created_at
sort=name
sort=-created_at,name

📌 Example Requests#

1. Prefix search + newest first#

GET /v1/distributions?filter[name][starts-with]=cdn-&sort=-created_at

2. Status + type + alphabetical#

GET /v1/distributions?filter[status][in]=active,disabled&filter[domain_type][eq]=system&sort=name

3. Created date range#

GET /v1/distributions?filter[created_at][between]=2025-01-01,2025-08-01&sort=-created_at

4. SSL-only#

GET /v1/distributions?filter[enable_ssl][eq]=true

✅ Success Response#

Status: 200 OK
{
"success": true,
"count": 2,
"data": [
{
"id": "uuid",
"name": "cdn-example",
"status": "active",
"domain_type": "system",
"enable_ssl": true,
"created_at": "2025-02-01T12:00:00Z",
"updated_at": "2025-02-10T12:00:00Z"
}
]
}

❌ Error Response#

Status: 400 Bad Request
{
"success": false,
"message": "Invalid filter query",
"errors": {
"filter": "Unsupported field or operator"
}
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.tenbyte.io/distributions' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
"data": [
{
"created_at": "2025-08-18T06:04:15Z",
"description": "Seeded distribution 94399",
"updated_at": "2025-08-18T06:04:45Z",
"domain_type": "managed",
"name": "Distribution #94399",
"cname": "smartroute.tenbytecdn.com",
"domain": "tb-uhlpi0becq.tenbytecdn.com",
"status": "active",
"cache_strategy": "dynamic",
"organization_id": "dd48af2e-7eb5-46c6-b12d-82001e35a574",
"id": "000075b4-36ef-47da-9443-7d5742bc7a95",
"is_acme_challenge_valid": true,
"enable_ssl": true,
"le_issue": true,
"is_redirect_http_to_https": true,
"is_http2": true,
"is_cname_valid": false,
"is_http3": true
},
{
"created_at": "2025-08-18T06:04:15Z",
"description": "Seeded distribution 8999",
"updated_at": "2025-08-18T06:04:18Z",
"domain_type": "managed",
"name": "Distribution #8999",
"cname": "smartroute.tenbytecdn.com",
"domain": "tb-dkmbyy0d8d.tenbytecdn.com",
"status": "provisioning",
"cache_strategy": "custom",
"organization_id": "7cbdca03-5950-458b-9a97-005691cd64b4",
"id": "00011542-0b0e-4bf9-a369-8c1baeba8e32",
"is_acme_challenge_valid": false,
"enable_ssl": true,
"le_issue": true,
"is_redirect_http_to_https": true,
"is_http2": true,
"is_cname_valid": true,
"is_http3": true
},
{
"created_at": "2025-08-18T06:04:15Z",
"description": "Seeded distribution 9849",
"updated_at": "2025-08-18T06:04:18Z",
"domain_type": "custom",
"name": "Distribution #9849",
"cname": "smartroute.tenbytecdn.com",
"domain": "tb-hwdcfpsz3m.tenbytecdn.com",
"status": "disabled",
"cache_strategy": "live",
"organization_id": "66dfacfe-e0c7-4c62-b0d0-a853341df6ee",
"id": "0001559a-6255-4731-81f2-90e386026824",
"is_acme_challenge_valid": true,
"enable_ssl": true,
"le_issue": true,
"is_redirect_http_to_https": true,
"is_http2": true,
"is_cname_valid": true,
"is_http3": true
},
{
"created_at": "2025-08-18T06:04:15Z",
"description": "Seeded distribution 81829",
"updated_at": "2025-08-18T06:04:41Z",
"domain_type": "managed",
"name": "Distribution #81829",
"cname": "smartroute.tenbytecdn.com",
"domain": "tb-pm38xm08f8.tenbytecdn.com",
"status": "active",
"cache_strategy": "custom",
"organization_id": "18498b73-a1db-481c-8c23-262166b3a96d",
"id": "00016131-549e-4235-b325-d17a0e11f0c4",
"is_acme_challenge_valid": true,
"enable_ssl": true,
"le_issue": false,
"is_redirect_http_to_https": true,
"is_http2": true,
"is_cname_valid": false,
"is_http3": false
},
{
"created_at": "2025-08-18T06:04:15Z",
"description": "Seeded distribution 21994",
"updated_at": "2025-08-18T06:04:21Z",
"domain_type": "system",
"name": "Distribution #21994",
"cname": "smartroute.tenbytecdn.com",
"domain": "tb-oclcrivsom.tenbytecdn.com",
"status": "active",
"cache_strategy": "live",
"organization_id": "68fa2c9d-0e97-4a92-b773-6f6faf4bdb9f",
"id": "00021e15-95eb-4065-bec3-a8aef676fdde",
"is_acme_challenge_valid": false,
"enable_ssl": true,
"le_issue": true,
"is_redirect_http_to_https": true,
"is_http2": true,
"is_cname_valid": true,
"is_http3": true
}
],
"meta": {
"links": {
"self": "/distributions?limit=5&page=1",
"first": "/distributions?limit=5&page=1",
"next": "/distributions?limit=5&page=2",
"last": "/distributions?limit=5&page=20000"
},
"pagination": {
"page": 1,
"page_size": 5,
"total": 100000,
"total_pages": 20000
}
},
"message": "Request processed successfully.",
"success": true
}
Modified at 2025-10-04 13:06:59
Previous
Get Distribution Stats
Next
Delete Distribution
Built with