Jump to Content
Home
API Reference
Home
API Reference
v1.0
Home
API Reference
API Reference
v1.0
API Reference
Welcome to the Zype API Documentation
All
Pages
Start typing to search…
JUMP TO
Overview
Welcome to the Zype API Documentation
Zype Platform
Videos
List Videos
get
Create Video
post
View Video
get
Update Video
put
Delete Video
del
Add Zobject(s)
put
Remove Zobject
put
Download Video
get
List Ad Timings
get
List Ad Timings for Single Data Source
get
Create Ad Timing
post
View Ad Timing
get
Update Ad Timing
put
Destroy Ad Timing
del
Create Self Hosted Video
post
List Self Hosted Video Data Sources
get
Create a Self Hosted Video Data Source
post
View Self Hosted Video Data Source
get
Update Self Hosted Video Data Source
put
Delete Self Hosted Video Data Source
del
Playlists
List Playlists
get
Create Playlist
post
View Playlist
get
Update Playlist
put
Delete Playlist
del
List Playlist Videos
get
List Relative Playlist Videos
get
Add Videos
put
Remove Videos
put
View Relationships
get
Categories
List Categories
get
Create Category
post
View Category
get
Update category
put
Delete Category
del
Apps
View App
get
Subtitles
List Subtitles
get
Create Subtitle
post
View Subtitle
get
Update Subtitle
put
Subtitle Playlists
Create Subtitle Playlist
post
Delete Subtitle Playlist
del
Program Guides
List Program Guides
get
Create Program Guide
post
View Program Guide
get
Update Program Guide
put
Delete Program Guide
del
List Program Guide Entries
get
Devices
List Devices
get
View Device
get
Device Categories
List Devices Categories
get
View Device Category
get
Live Manifests
Retrieve manifest URL for live videos
get
GeoIP
View GeoIP
get
Segments
List Segments
get
Create Segment
post
View Segment
get
Update Segment
put
Delete Segment
del
Video Imports
List Video Imports
get
Create Video Import
post
Attach a Video to a Video Import
put
View Video Import
get
Video Sources
List Video Sources
get
Create Video Source
post
View Video Source
get
Update Video Source
put
Delete a Video Source
del
Users
List Admin Users
get
Create User
post
View User
get
Update user
put
Remove an admin user from your property.
put
Encoders
List Encoders
get
View Encoder
get
Start an Encoder
post
Stop an Encoder
post
List Targets RTMP entries
get
View Target RTMP entry
get
Live Events
List Live Events
get
Create Live Event
post
View Live Event
get
Update live event
put
Delete live event
del
Start broadcasting a live event
put
Stop broadcasting a live event
put
Archive a live event
put
Uploads
Uploads
Create Upload
post
Content Rules
Category Content Rules
List Content Rules for a Category
get
Create Category Content Rule
post
View Category Content Rule
get
Update Category Content Rule
put
Delete Category Content Rule
del
Playlist Content Rules
List Playlist Content Rules
get
Create Playlist Content Rule
post
View Playlist Content Rule
get
Update Playlist Content Rule
put
Delete Playlist Content Rule
del
Video Content Rules
List Video Content Rules
get
Create Video Content Rule
post
View Video Content Rule
get
Update Video Content Rule
put
Delete Video Content Rule
del
Consumers
Consumers
List Consumers
get
Create Consumers
post
View Consumer
get
Update Consumer
put
Delete Consumer
del
Reset Consumer Parental Access Code
put
Initiate Consumer Forgot Password Flow - Consumer receives forgot password email.
put
Reset Consumer's Password Flow
put
Device Linking
Retrieve Device Pin
get
Acquire Device Pin
post
Link Device Pin
put
Unlink Device Pin
put
Video Entitlements
Check Video Entitlement
get
List Video Entitlements
get
Create video entitlement
post
View Video Entitlement
get
Update Video Entitlement
put
Delete Video Entitlement
del
Playlist Entitlements
List Playlist Entitlements
get
Create a Playlist Entitlement
post
View Playlist Entitlement
get
Update Playlist Entitlement
put
Delete Playlist Entitlement
del
Subscription Entitlements
List Subscription Entitlements
get
Video Favorites
List Video Favorites
get
Create Video Favorite
post
Delete Video Favorite
del
Monetization
Subscriptions
List Subscriptions
get
Create a Subscription
post
View Subscription
get
Update Subscription
put
Delete Subscription
del
Cancel Subscription
put
Reactivate Cancelled Subscription
put
Plans
List Plans
get
Create Plan
post
View Plan
get
Update Plan
put
Delete Plan
del
Add Playlists to a Tiered Subscription Plan
put
Remove Playlists from a Subscription Plan
put
Transactions
List Transactions
get
Create Transactions
post
View Transaction
get
Update a Transaction
put
Delete Transaction
del
Redemption Codes
List Redemption Codes
get
Create Redemption Codes
post
View Redemption Code
get
Update Redemption Code
put
Delete Redemption Code
del
Redeem an available Redemption Code
post
Create multiple Redemption Codes at once
post
Ad Tags
List Ad Tags
get
Create Ad Tags
post
View Ad Tag
get
Update Ad Tag
put
Delete Ad Tag
del
Revenue Models
List Revenue Models
get
View Revenue Model
get
Player
Players
View Player
get
Playlist Carousel Embed
View Playlist Carousel Embed
get
Zobjects
Zobject Types
List Zobject Types
get
Create Zobject Type
post
Retrieve Zobject Type
get
Update Zobject Type
put
Delete Zobject Type
del
Zobjects
List Zobjects
get
Create Zobject
post
Retrieve Zobject
get
Update Zobject
put
Delete Zobject
del
Add Video(s)
put
Remove Video(s)
put
Retrieve Video(s)
get
Add Playlist(s)
put
Remove Playlist(s)
put
Retrieve Playlist(s)
get
Consumer Authentication
Oauth
Retrieving an Access Token
post
Retrieving Access Token Status
get
Revoke Access Token
post
Analytics (V2)
Stream Hours
List Stream Hours (V2)
get
Player Requests
List Player Requests
get
Engagement
List Engagement Data
get
Site Counts
List Site Counts Data
get
New Subscriptions
List New Subscriptions
get
Subscription Events
List Subscription Events
get
Subscription Revenue
List Subscription Revenue
get
New Transactions
List New Transactions
get
Consumers
List Consumers
get
Analytics (V3)
Platform Dynamics
List Consumers
get
List Metrics Data
get
List Player Requests
get
List Stream Hours
get
List Playout Hours
get
Revenue
List New Subscriptions
get
List Subscription Events
get
List Subscription Revenue
get
List New Transactions
get
Engagement
Plays
get
Viewers
get
Hours Watched
get
View Time
get
Common API Examples
3rd Party Payment Provider & Subscription Management Quickstart
Playout Scheduler
Channels
List Channels
get
Create Channel
post
View Channel
get
Delete Channel
del
Update Channel
put
Stop On-Air Channel
post
Sync automated graphic insertions
post
HLS Profiles
List HLS Profiles
get
Create HLS Profile
post
View HLS Profile
get
Delete HLS Profile
del
Update HLS Profile
put
Duplicate HLS Profile
post
Destinations
List Destination Types
get
View Destination Type
get
List Destinations
get
Create Destination
post
View Destination
get
Delete Destination
del
Update Destination
put
Draft Versions
View Channel's Draft
get
View track item's automated graphics
get
View Channel Draft's Schedule Rundown
get
Publish Channel's Draft
post
Timeline Operations
List Operations
get
Create Operation
post
Revert all operations
del
View Operation
get
Revert a Draft Schedule to the specified operation
post
Published Versions
View Channel's Published
get
Assets
List Blocks
get
Create Block
post
View Block
get
Update Block
put
Delete Block
del
List Ads
get
View Ad
get
List Bumpers
get
View Bumper
get
List Videos
get
View Video
get
List Playlists
get
View Playlist
get
List Ad Timings
get
Create Ad Timing
post
Delete Ad Timings
del
Update Ad Timing
put
Delete Ad Timing
del
List Live Assets
get
Create Live Asset
post
Update Live Asset
put
Delete Live Asset
del
List Graphics
get
Create Graphic
post
View Graphic
get
Update Graphic
put
Delete Graphic
del
Uploads
Get Upload
get
EPG
JSON Rundown EPG
get
View Channel's Published Rundown XMLTV format
get
Vizio EPG
get
Tcl EPG
get
Wurl EPG
get
Roku EPG
get
Recurrence Rules
List Recurrence Rules
get
Create Recurrence Rule
post
View Recurrence Rule
get
Delete Recurrence Rule
del
Update Recurrence Rule
put
Uploads
Create Upload
post
TVE
Adobe
Register Adobe Device Session
post
Creates a Zype's Consumer
post
Validate Device Session token
post
Retrieves the list of preauthorized resources
post
Obtains Short Media Token.
post
Destroys Device Session.
del
Powered by
Welcome to the Zype API Documentation
Ask AI
