Zype

  • Guides
  • API Reference

    Zype Developer Hub

    If you’re a developer, you’ve come to the right place! Here we’ll discuss the Zype platform and how to leverage it to deploy your video content. We recommend clicking on the Platform Documentation link in the nav bar to get started or checkout our API Documentation for working with our API.

    v1.0
    • v1.0stable
    HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
      HomeGuidesAPI ReferenceChangelog
    discard

    Getting Started

    • Getting Started with Zype Core

    Videos

    • Video Entitlements
      • Subscriptions
      • Pass Plans
      • Purchase & Rental
      • Geo Targeting with Content Rules

    Developer Case Studies

    • Custom Authentication Flow
    • Zype Video API

    Getting Started

    • Getting Started with Zype Core

    Videos

    • Video Entitlements
      • Subscriptions
      • Pass Plans
      • Purchase & Rental
      • Geo Targeting with Content Rules

    Developer Case Studies

    • Custom Authentication Flow
    • Zype Video API

    Overview

    • Welcome to the Zype API Documentation

    Zype Platform

    • Videos
      • get
        List Videos
      • post
        Create Video
      • get
        View Video
      • put
        Update Video
      • delete
        Delete Video
      • put
        Add Zobject(s)
      • put
        Remove Zobject(s)
      • get
        Download Video
      • get
        List Ad Timings
      • get
        List Ad Timings on single Data Source
      • post
        Create new Ad Timing on Data Source
      • get
        View Ad Timing
      • put
        Update Ad Timing
      • delete
        Destroy an Ad Timing
      • post
        Create A Self Hosted Video
    • Playlists
      • get
        List Playlists
      • post
        Create Playlist
      • get
        View Playlist
      • put
        Update Playlist
      • delete
        Delete Playlist
      • get
        List Playlist Videos
      • put
        Add Videos
      • put
        Remove Videos
      • get
        View Relationsips
    • Categories
      • get
        List Categories
      • post
        Create Category
      • get
        View Category
      • put
        Update category
      • delete
        Delete Category
    • Apps
      • get
        View App
    • Subtitles
      • get
        List Subtitles
      • post
        Create Subtitle
      • get
        View Subtitle
      • put
        Update Subtitle
      • delete
        Delete Subtitle
    • Subtitle Playlists
      • post
        Create Subtitle Playlist
      • delete
        Delete Subtitle Playlist
    • Program Guides
      • get
        List Program Guides
      • post
        Create Program Guide
      • get
        View Program Guide
      • put
        Update Program Guide
      • delete
        Delete Program Guide
      • get
        List Program Guide Entries
    • Devices
      • get
        List Devices
      • get
        View Device
    • Device Categories
      • get
        List Devices Categories
      • get
        View Device Category
    • Live Manifests
      • get
        Retrieve manifest URL for live videos
    • GeoIP
      • get
        View GeoIP
    • Segments
      • get
        List Segments
      • post
        Create Segment
      • get
        View Segment
      • put
        Update Segment
      • delete
        Delete Segment
    • Video Imports
      • get
        List Video Imports
      • post
        Create Video Import
      • put
        Attach a Video to a Video Import
      • get
        View Video Import
    • Video Sources
      • get
        List Video Sources
      • post
        Create Video Source
      • get
        View Video Source
      • put
        Update Video Source
      • delete
        Delete a Video Source
    • Users
      • get
        List Admin Users
      • post
        Create User
      • get
        View User
      • put
        Update user
      • put
        Remove an admin user from your property.
    • Encoders
      • get
        List Encoders
      • get
        View Encoder
      • post
        Start an Encoder
      • post
        Stop an Encoder
      • get
        List Targets RTMP entries
      • post
        Create Target RTMP entry
      • get
        View Target RTMP entry
      • put
        Update Target RTMP entry
    • Live Events
      • get
        List Live Events
      • post
        Create Live Event
      • get
        View Live Event
      • put
        Update live event
      • delete
        Delete live event
      • put
        Start broadcasting a live event
      • put
        Stop broadcasting a live event
      • put
        Archive a live event

    Uploads

    • Uploads
      • post
        Create Upload

    Content Rules

    • Category Content Rules
      • get
        List Content Rules for a Category
      • post
        Create Category Content Rule
      • get
        View Category Content Rule
      • put
        Update Category Content Rule
      • delete
        Delete Category Content Rule
    • Playlist Content Rules
      • get
        List Playlist Content Rules
      • post
        Create Playlist Content Rule
      • get
        View Playlist Content Rule
      • put
        Update Playlist Content Rule
      • delete
        Delete Playlist Content Rule
    • Video Content Rules
      • get
        List Video Content Rules
      • post
        Create Video Content Rule
      • get
        View Video Content Rule
      • put
        Update Video Content Rule
      • delete
        Delete video content rule

    Consumers

    • Consumers
      • get
        List Consumers
      • post
        Create Consumers
      • get
        View Consumer
      • put
        Update Consumer
      • delete
        Delete Consumer
      • put
        Initiate Consumer Forgot Password Flow - Consumer receives forgot password email.
      • put
        Reset Consumer's Password Flow
    • Device Linking
      • get
        Retrieve Device Pin
      • post
        Acquire Device Pin
      • put
        Link Device Pin
      • put
        Unlink Device Pin
    • Video Entitlements
      • get
        Check Video Entitlement
      • get
        List Video Entitlements
      • post
        Create video entitlement
      • get
        View Video Entitlement
      • put
        Update Video Entitlement
      • delete
        Delete Video Entitlement
    • Playlist Entitlements
      • get
        List Playlist Entitlements
      • post
        Create a Playlist Entitlement
      • get
        View Playlist Entitlement
      • put
        Update Playlist Entitlement
      • delete
        Delete Playlist Entitlement
    • Subscription Entitlements
      • get
        List Subscription Entitlements

    Monetization

    • Subscriptions
      • get
        List Subscriptions
      • post
        Create a Subscription
      • get
        View Subscription
      • put
        Update Subscription
      • delete
        Delete Subscription
      • put
        Cancel Subscription
      • put
        Reactivate Cancelled Subscription
    • Plans
      • get
        List Plans
      • post
        Create Plan
      • get
        View Plan
      • put
        Update Plan
      • delete
        Delete Plan
      • put
        Add Playlists to a Tiered Subscription Plan
      • put
        Remove Playlists from a Subscription Plan
    • Transactions
      • get
        List Transactions
      • post
        Create Transactions
      • get
        View Transaction
      • put
        Update a Transaction
      • delete
        Delete Transaction
    • Redemption Codes
      • get
        List Redemption Codes
      • post
        Create Redemption Codes
      • get
        View Redemption Code
      • put
        Update Redemption Code
      • delete
        Delete Redemption Code
      • post
        Redeem an available Redemption Code
      • post
        Create multiple Redemption Codes at once
    • Ad Tags
      • get
        List Ad Tags
      • post
        Create Ad Tags
      • get
        View Ad Tag
      • put
        Update Ad Tag
      • delete
        Delete Ad Tag
    • Revenue Models
      • get
        List Revenue Models
      • get
        View Revenue Model
    • Video Favorites
      • get
        List Video Favorites
      • post
        Create Video Favorite
      • delete
        Delete Video Favorite

    Player

    • VOD Manifests
      • get
        Retrieve manifest file contents
    • Players
      • get
        View Player
    • Playlist Carousel Embed
      • get
        View Playlist Carousel Embed

    Zobjects

    • Zobject Types
      • get
        List Zobject Types
      • post
        Create Zobject Type
      • get
        Retrieve Zobject Type
      • put
        Update Zobject Type
      • delete
        Delete Zobject Type
    • Zobject
      • get
        List Zobjects
      • post
        Create Zobject
      • get
        Retrieve Zobject
      • put
        Update Zobject
      • delete
        Delete Zobject
      • put
        Add Video(s)
      • put
        Remove Video(s)
      • get
        Retrieve Video(s)

    Consumer Authentication

    • OAuth
      • post
        Retrieving an Access Token
      • get
        Retrieving Access Token Status

    Analytics

    • Stream Hours
      • get
        List Stream Hours (V2)
      • get
        List Stream Hours (V3)
    • Player Requests
      • get
        List Player Requests
    • Engagement
      • get
        List Engagement Data
    • Site Counts
      • get
        List Site Counts Data
    • Consumers
      • get
        List Consumers
    • New Subscriptions
      • get
        List New Subscriptions
    • New Transactions
      • get
        List New Transactions
    • Playout Hours
      • get
        List Playout Hours

    Common API Examples

    • 3rd Party Payment Provider & Subscription Management Quickstart
    Powered by