Create Scheduled Playlist

Create new scheduled playlist

curl -X POST "https://api.5centscdn.com/v2/streams/scheduledplaylist/new" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "name": "testing",
  "parent": "2314,stream",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "preroll": "N",
  "loop": "N",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[ips]": "",
  "domainlock[noreferer]": "N",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list]": [],
  "geoblock[ips]": "",
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[timeout]": 3600,
  "securetoken[session]": "0",
  "securetoken[keyip]": "N",
  "securetoken[ips]": "",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "_METHOD": "PUT"
}'

import requests
import json

url = "https://api.5centscdn.com/v2/streams/scheduledplaylist/new"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "name": "testing",
  "parent": "2314,stream",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "preroll": "N",
  "loop": "N",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[ips]": "",
  "domainlock[noreferer]": "N",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list]": [],
  "geoblock[ips]": "",
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[timeout]": 3600,
  "securetoken[session]": "0",
  "securetoken[keyip]": "N",
  "securetoken[ips]": "",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "_METHOD": "PUT"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.5centscdn.com/v2/streams/scheduledplaylist/new", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "name": "testing",
  "parent": "2314,stream",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "preroll": "N",
  "loop": "N",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[ips]": "",
  "domainlock[noreferer]": "N",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list]": [],
  "geoblock[ips]": "",
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[timeout]": 3600,
  "securetoken[session]": "0",
  "securetoken[keyip]": "N",
  "securetoken[ips]": "",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "_METHOD": "PUT"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "testing",
  "parent": "2314,stream",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "preroll": "N",
  "loop": "N",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[ips]": "",
  "domainlock[noreferer]": "N",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list]": [],
  "geoblock[ips]": "",
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[timeout]": 3600,
  "securetoken[session]": "0",
  "securetoken[keyip]": "N",
  "securetoken[ips]": "",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "_METHOD": "PUT"
}`)

    req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/streams/scheduledplaylist/new", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("X-API-Key", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.5centscdn.com/v2/streams/scheduledplaylist/new')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
  "name": "testing",
  "parent": "2314,stream",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "preroll": "N",
  "loop": "N",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[ips]": "",
  "domainlock[noreferer]": "N",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list]": [],
  "geoblock[ips]": "",
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[timeout]": 3600,
  "securetoken[session]": "0",
  "securetoken[keyip]": "N",
  "securetoken[ips]": "",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "_METHOD": "PUT"
}'

response = http.request(request)
puts response.body

{
  "result": "success",
  "message": "Stream Created",
  "stream": {
    "monitoring_id": null,
    "type": "scheduledplaylist",
    "id": 72274,
    "serviceid": 103,
    "name": "103_push_2314_001/testing",
    "codec": "h264",
    "ingests": [
      [],
      null
    ],
    "protocols": [
      [
        "HLS"
      ],
      [
        "HLS"
      ]
    ],
    "parentid": 2314,
    "server": "N",
    "backup": "N",
    "dedicatedLTC": "0",
    "hasAdvancedFeatures": "0",
    "monitoring_triggers": null,
    "draft": "0",
    "disabled": "0",
    "created_at": "2026-05-01 13:18:21",
    "updated_at": "2026-05-01 13:18:21",
    "lastseen_at": false,
    "deleted": null,
    "ingestsLock": 0,
    "protocolsLock": 0,
    "status": "Enabled",
    "has": {
      "rtmp": 0,
      "rtsp": 0,
      "hls": 1,
      "dash": 0,
      "rtmpauth": "Y"
    },
    "fms": {
      "server": {
        "country": "SouthEast Asia",
        "meta": {
          "fmsUrl": "rtmp://fms-01-01.5centscdn.com"
        }
      }
    },
    "parts": {
      "pp": "103_push_2314_001",
      "sn": "testing",
      "full": "103_push_2314_001testing"
    },
    "restream": {},
    "playbackurls": {
      "scheme": "https",
      "url_prefix": "https://stream-abc12-hls-live.stream.example.com",
      "rtmp": "rtmp://rtmp.5centscdn.com:1935/",
      "rtsp": "rtsp://rtsp.5centscdn.com:554/",
      "hlsManifest": "playlist_dvr.m3u8",
      "dashManifest": "manifest_dvr.mpd",
      "hls": "https://hash-hls-live.5centscdn.com",
      "dash": "https://hash-hls-live.5centscdn.com",
      "players": {
        "flowplayer": {
          "baseQ": "",
          "base": "https://cdn.example.com/flowplayer/hls/",
          "hls": "https://cdn.example.com/flowplayer/hls/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4"
        },
        "videojs": {
          "baseQ": "",
          "base": "https://cdn.example.com/videojs/hls/",
          "hls": "https://cdn.example.com/videojs/hls/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4"
        },
        "own": {
          "hashes": {
            "stream-abc12-hls-live.stream.example.com": {
              "hash": "5jlu93s1z7ma6021",
              "hls": "https://hash-hls-live.5centscdn.com",
              "base64": "aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4",
              "dash": "https://hash-hls-live.5centscdn.com",
              "base64dash": "aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4"
            }
          },
          "baseQ": "?showcv=true&title=103_push_2314_001/testing",
          "base": "https://cdn.example.com/player/hls/skin1//",
          "hls": "https://cdn.example.com/player/hls/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=103_push_2314_001/testing",
          "dash": "https://cdn.example.com/player/dash/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=103_push_2314_001/testing"
        }
      },
      "tokenized": {
        "scheme": "https",
        "url_prefix": "https://stream-abc12-hls-live.stream.example.com",
        "rtmp": "rtmp://rtmp.5centscdn.com:1935/",
        "rtsp": "rtsp://rtsp.5centscdn.com:554/",
        "hlsManifest": "playlist_dvr.m3u8",
        "dashManifest": "manifest_dvr.mpd",
        "hls": "https://hash-hls-live.5centscdn.com",
        "dash": "https://hash-hls-live.5centscdn.com",
        "players": {
          "hostname": "cdn.example.com",
          "flowplayer": {
            "baseQ": "",
            "base": "https://cdn.example.com/flowplayer/hls/",
            "hls": "https://cdn.example.com/flowplayer/hls/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4",
            "dash": "https://cdn.example.com/flowplayer/dash/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4"
          },
          "videojs": {
            "baseQ": "",
            "base": "https://cdn.example.com/videojs/hls/",
            "hls": "https://cdn.example.com/videojs/hls/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4",
            "dash": "https://cdn.example.com/videojs/dash/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4"
          },
          "own": {
            "baseQ": "?showcv=true&title=103_push_2314_001/testing",
            "base": "https://cdn.example.com/player/hls/skin1//",
            "hls": "https://cdn.example.com/player/hls/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=103_push_2314_001/testing",
            "dash": "https://cdn.example.com/player/dash/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=103_push_2314_001/testing"
          }
        },
        "path": {
          "hls": "/103_push_2314_001/testing/playlist_dvr.m3u8",
          "dash": "/103_push_2314_001/testing/manifest_dvr.mpd"
        },
        "token": {
          "hls": "md5=DiaLMfOCM6yiSPCUmXxORA&path=%2F103_push_2314_001%2Ftesting&expires=1777980554",
          "dash": "md5=DiaLMfOCM6yiSPCUmXxORA&path=%2F103_push_2314_001%2Ftesting&expires=1777980554"
        }
      }
    },
    "platformsCount": 0,
    "ssl_enabled": true,
    "hash": "testing",
    "securetoken": {
      "enabled": "Y",
      "policy": "D",
      "keyip": "N",
      "list": "32862cdb6276e19a",
      "timeout": 3600,
      "session": "0",
      "ips": "",
      "dirs": null,
      "active": "Y"
    },
    "preroll": "N",
    "loop": "N",
    "zone": {
      "id": 2314,
      "type": "push",
      "mode": "http",
      "name": "push-2314",
      "ftpdetails": {
        "username": "vineeth_103_push_2314"
      }
    },
    "hasInstantSchedule": true,
    "playlistCount": 1,
    "playlists": [
      {
        "id": 9265,
        "streamid": 72274,
        "name": "default",
        "schedule": "instant",
        "scheduletime": 0,
        "type": "file",
        "repeatfor": 0,
        "repeatintervaldays": 0,
        "loop": "1",
        "length": "00:00:00",
        "autorestart": "0",
        "videos": [
          {
            "src": "/2.mp4",
            "start": "0",
            "duration": "0",
            "ad_breaks": [
              {
                "start": 67,
                "duration": 30
              }
            ]
          }
        ],
        "serviceid": 103,
        "files": [
          "/2.mp4"
        ],
        "durations": [
          [
            0,
            0
          ]
        ],
        "ad_breaks": [
          []
        ]
      }
    ],
    "domainlock": {
      "enabled": "Y",
      "policy": "Y",
      "list": "example.com,docs.example.com",
      "ips": "",
      "noreferer": "N",
      "active": "Y"
    },
    "geoblock": {
      "enabled": "Y",
      "policy": "Y",
      "list": [
        ""
      ],
      "ips": "",
      "active": "Y"
    },
    "ipaccess": {
      "enabled": "Y",
      "policy": "N",
      "list": "",
      "ips": "",
      "active": "N"
    },
    "useragent": {
      "enabled": "Y",
      "policy": "Y",
      "list": "",
      "ips": "",
      "casesensitive": "N",
      "active": "N",
      "listArr": [
        ""
      ]
    },
    "transcode": {
      "ltc": 0,
      "type": "mixed",
      "enabled": false,
      "isEditable": true
    },
    "platforms": [
      {
        "id": 43459,
        "rtmp": "rtmp://rtmp.5centscdn.com:1935/",
        "auth": "Y",
        "username": "admin",
        "password": "password",
        "isSRT": false,
        "key": "password",
        "schedule": "scheduleontime",
        "scheduletime": "06:12",
        "codec": null,
        "length": "19:14",
        "relid": 57197,
        "dedicatedLTC": "0",
        "transcode": {
          "ltc": 0,
          "type": "mixed",
          "enabled": false,
          "isEditable": true
        },
        "disabled": "0",
        "name": "Custom RTMP",
        "platform_id": 1,
        "provider_id": 0,
        "video_id": ""
      }
    ],
    "messages": {},
    "adInsertion": null
  }
}

POST

/streams/scheduledplaylist/new

POST

Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)

X-API-Keystring

Required

API key (sent in header)

Content-Typestring

Required

The media type of the request body

Options: application/json

namestring

Required

Friendly name for this resource.

parentstring

Required

Parent zone or push zone name to attach this stream to.

codecstring

Video codec for the stream. Use h264 or h265.

protocolsarray

List of output protocols. Values include HLS, RTMP, DASH, RTSP.

prerollstring

Enable pre-roll ads. Y means enabled, N means disabled.

loopstring

Loop playback. Y means loop continuously, N means play once.

domainlock[enabled]string

Enable or disable domain lock. Y means enabled, N means disabled.

domainlock[policy]string

Domain lock policy. Y means allow listed domains, N means deny.

domainlock[list]string

Comma-separated list of allowed domains.

domainlock[ips]string

Comma-separated list of IP addresses for domain lock.

domainlock[noreferer]string

Whether to block referrer header. Y means blocked, N means allowed.

geoblock[enabled]string

Enable or disable geo block. Y means enabled, N means disabled.

geoblock[policy]string

Geo block policy. Y means block listed countries, N means allow.

geoblock[list]array

List of ISO country codes to block or allow.

geoblock[ips]string

Comma-separated IPs for geo block.

securetoken[enabled]string

Enable or disable secure token. Y means enabled, N means disabled.

securetoken[policy]string

Secure token policy. D means dynamic, F means fixed.

securetoken[list]string

Secure token key identifier.

securetoken[timeout]integer

Token validity duration in seconds.

securetoken[session]string

Session limit. 0 means unlimited.

securetoken[keyip]string

Whether token is bound to IP. Y means IP-bound, N means not bound.

securetoken[ips]string

Comma-separated IPs for secure token.

useragent[enabled]string

Enable or disable user agent control. Y means enabled, N means disabled.

useragent[policy]string

User agent policy. Y means allow listed agents, N means deny.

useragent[list]string

Comma-separated list of user agents.

useragent[casesensitive]string

Whether user agent matching is case sensitive.

ipaccess[enabled]string

Enable or disable IP access control. Y means enabled, N means disabled.

ipaccess[policy]string

IP access policy. Y means allow listed IPs, N means deny.

ipaccess[list]string

Comma-separated list of IPs for access control.

ipaccess[ips]string

Additional IP addresses for access control.

_METHODstring

HTTP method override for this request. This endpoint accepts POST, but set this to PUT to perform an update operation.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

X-API-Keystring

Required

API Key for authentication. Provide your API key in the header.

Body

application/json

namestring

Required

Friendly name for this resource.

Example:

testing

parentstring

Required

Parent zone or push zone name to attach this stream to.

Example:

2314,stream

codecstring

Video codec for the stream. Use h264 or h265.

Example:

h264

protocolsarray

List of output protocols. Values include HLS, RTMP, DASH, RTSP.

Example:

["HLS"]

prerollstring

Enable pre-roll ads. Y means enabled, N means disabled.

Example:

N

loopstring

Loop playback. Y means loop continuously, N means play once.

Example:

N

domainlock[enabled]string

Enable or disable domain lock. Y means enabled, N means disabled.

Example:

Y

domainlock[policy]string

Domain lock policy. Y means allow listed domains, N means deny.

Example:

Y

domainlock[list]string

Comma-separated list of allowed domains.

Example:

example.com,docs.example.com

domainlock[ips]string

Comma-separated list of IP addresses for domain lock.

Example:

domainlock[noreferer]string

Whether to block referrer header. Y means blocked, N means allowed.

Example:

N

geoblock[enabled]string

Enable or disable geo block. Y means enabled, N means disabled.

Example:

Y

geoblock[policy]string

Geo block policy. Y means block listed countries, N means allow.

Example:

Y

geoblock[list]array

List of ISO country codes to block or allow.

Example:

[]

geoblock[ips]string

Comma-separated IPs for geo block.

Example:

securetoken[enabled]string

Enable or disable secure token. Y means enabled, N means disabled.

Example:

Y

securetoken[policy]string

Secure token policy. D means dynamic, F means fixed.

Example:

D

securetoken[list]string

Secure token key identifier.

Example:

32862cdb6276e19a

securetoken[timeout]integer

Token validity duration in seconds.

Example:

3600

securetoken[session]string

Session limit. 0 means unlimited.

Example:

0

securetoken[keyip]string

Whether token is bound to IP. Y means IP-bound, N means not bound.

Example:

N

securetoken[ips]string

Comma-separated IPs for secure token.

Example:

useragent[enabled]string

Enable or disable user agent control. Y means enabled, N means disabled.

Example:

Y

useragent[policy]string

User agent policy. Y means allow listed agents, N means deny.

Example:

Y

useragent[list]string

Comma-separated list of user agents.

Example:

useragent[casesensitive]string

Whether user agent matching is case sensitive.

Example:

N

ipaccess[enabled]string

Enable or disable IP access control. Y means enabled, N means disabled.

Example:

Y

ipaccess[policy]string

IP access policy. Y means allow listed IPs, N means deny.

Example:

N

ipaccess[list]string

Comma-separated list of IPs for access control.

Example:

ipaccess[ips]string

Additional IP addresses for access control.

Example:

_METHODstring

HTTP method override for this request. This endpoint accepts POST, but set this to PUT to perform an update operation.

Example:

PUT

Responses

resultstring

Status of the API response.

messagestring

Human-readable message describing the result.

streamobject

Stream object containing configuration and status details.

monitoring_idstring

Unique monitoring identifier for the stream.

typestring

Type identifier for this stream or object.

idinteger

Unique numeric identifier.

serviceidinteger

Unique identifier of the service this stream belongs to.

namestring

Name of the stream.

codecstring

Video codec used for the stream.

ingestsarray[]

List of active ingest connection details for each server.

protocolsarray[]

Supported streaming protocols for each server.

parentidinteger

Identifier of the parent stream, if this is a child stream.

serverstring

Server ID or identifier assigned to the stream.

backupstring

Backup server ID for failover.

dedicatedLTCstring

Whether a dedicated live transcoding server is allocated for this stream.

hasAdvancedFeaturesstring

Whether advanced features are enabled for this stream.

monitoring_triggersstring

Monitoring alert trigger configuration for the stream.

draftstring

Draft status flag. 0 means published; 1 means unpublished draft.

disabledstring

Disabled flag. 0 means active; 1 means disabled.

created_atstring

Timestamp when the stream was created.

updated_atstring

Timestamp when the stream was last updated.

lastseen_atstring

Timestamp of last seen activity, or false if never seen.

deletedstring

Deletion timestamp, or null if the stream is not deleted.

ingestsLockinteger

Whether the ingest endpoint list is locked from editing.

protocolsLockinteger

Whether the supported protocol list is locked from editing.

statusstring

Current deployment or operational status of the stream.

hasobject

Flags indicating which streaming protocols are active.

rtmpinteger

Whether RTMP streaming is enabled. 1 = enabled, 0 = disabled.

rtspinteger

Whether RTSP streaming is enabled. 1 = enabled, 0 = disabled.

hlsinteger

Whether HLS streaming is enabled. 1 = enabled, 0 = disabled.

dashinteger

Whether DASH streaming is enabled. 1 = enabled, 0 = disabled.

rtmpauthstring

Whether RTMP publish authentication is required.

fmsobject

Flash Media Server ingest configuration for the stream.

serverobject

Server ID or identifier assigned to the stream.

countrystring

Geographic region of the ingest server.

metaobject

Metadata object for the server.

fmsUrlstring

RTMP ingest URL for the assigned FMS server.

partsobject

Stream name components.

ppstring

Stream name prefix (part 1, before the slash).

snstring

Stream name suffix (part 2, after the slash).

fullstring

Combined full stream name without the slash separator.

restreamobject

Restream platform configuration object.

playbackurlsobject

Playback URL set for all supported protocols and player types.

schemestring

URL scheme used for playback.

url_prefixstring

Base CDN hostname URL used as a prefix for playback URLs.

rtmpstring

RTMP playback or destination URL.

rtspstring

RTSP playback URL.

hlsManifeststring

HLS manifest filename.

dashManifeststring

DASH manifest filename.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

playersobject

Embedded player iframe URL set for supported player types.

flowplayerobject

Flowplayer iframe URL information.

baseQstring

Query string appended to the player iframe URL.

basestring

Base player iframe URL without the stream path.

hlsstring

HLS playback or player iframe URL.

videojsobject

Video.js player iframe URL information.

baseQstring

Query string appended to the player iframe URL.

basestring

Base player iframe URL without the stream path.

hlsstring

HLS playback or player iframe URL.

ownobject

Native stream player iframe URL information.

hashesobject

Map of CDN hostname to stream hashes and playback URLs.

stream-abc12-hls-live.stream.example.comobject

hashstring

Short hash or slug used in stream URLs.

hlsstring

HLS playback or player iframe URL.

base64string

Base64-encoded HLS playback URL for use with iframe players.

dashstring

DASH playback or player iframe URL.

base64dashstring

Base64-encoded DASH playback URL for use with iframe players.

baseQstring

Query string appended to the player iframe URL.

basestring

Base player iframe URL without the stream path.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

tokenizedobject

Tokenized playback URL configuration, or null if disabled.

schemestring

URL scheme used for playback.

url_prefixstring

Base CDN hostname URL used as a prefix for playback URLs.

rtmpstring

RTMP playback or destination URL.

rtspstring

RTSP playback URL.

hlsManifeststring

HLS manifest filename.

dashManifeststring

DASH manifest filename.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

playersobject

Embedded player iframe URL set for supported player types.

hostnamestring

CDN hostname used for playback.

flowplayerobject

Flowplayer iframe URL information.

baseQstring

Query string appended to the player iframe URL.

basestring

Base player iframe URL without the stream path.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

videojsobject

Video.js player iframe URL information.

baseQstring

Query string appended to the player iframe URL.

basestring

Base player iframe URL without the stream path.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

ownobject

Native stream player iframe URL information.

baseQstring

Query string appended to the player iframe URL.

basestring

Base player iframe URL without the stream path.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

pathobject

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

tokenobject

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

platformsCountinteger

Number of external restreaming platforms configured.

ssl_enabledboolean

Whether HTTPS/SSL is enabled for playback.

hashstring

Short hash or slug used in stream URLs.

securetokenobject

Secure token URL signing configuration.

enabledstring

Enable or disable this feature.

policystring

Policy mode controlling allow/deny behavior.

keyipstring

Whether the token is bound to the viewer IP address.

liststring

Comma-separated list of allowed or blocked values.

timeoutinteger

Token expiry time in seconds.

sessionstring

Session-based token mode flag.

ipsstring

IP addresses associated with the access control policy.

dirsstring

URL directory paths restricted by this policy.

activestring

Whether this policy is currently enforced.

prerollstring

loopstring

Whether the playlist loops continuously.

zoneobject

idinteger

Unique numeric identifier.

typestring

Type identifier for this stream or object.

modestring

Operating mode for the configuration.

namestring

Name of the stream.

ftpdetailsobject

usernamestring

Username for RTMP authentication.

hasInstantScheduleboolean

playlistCountinteger

Total number of playlists configured for this stream.

playlistsarray

List of playlists configured for this stream.

idinteger

Unique numeric identifier.

streamidinteger

Unique identifier of the stream.

namestring

Name of the stream.

schedulestring

Schedule type. Values include instant, scheduleontime, scheduleondatetime.

scheduletimestring

Scheduled time. 0 for instant, or a datetime string for timed schedules.

typestring

Type identifier for this stream or object.

repeatforinteger

repeatintervaldaysinteger

Number of days between recurring schedule repetitions.

loopstring

Whether the playlist loops continuously.

lengthstring

Maximum stream length in hh:mm:ss format.

autorestartstring

videosarray

List of video items in the playlist.

srcstring

Source URL of the video or media asset.

startstring

Start position or timestamp.

durationstring

Duration of the item in seconds.

ad_breaksarray

List of ad break slots configured for this schedule.

startstring

durationstring

serviceidinteger

Unique identifier of the service this stream belongs to.

filesstring[]

durationsarray[]

Total duration values for playlist segments.

ad_breaksarray[]

List of ad break slots configured for this schedule.

domainlockobject

Domain lock (hotlink protection) configuration.

enabledstring

Enable or disable this feature.

policystring

Policy mode controlling allow/deny behavior.

liststring

Comma-separated list of allowed or blocked values.

ipsstring

IP addresses associated with the access control policy.

norefererstring

Whether to allow playback requests with no Referer header.

activestring

Whether this policy is currently enforced.

geoblockobject

Geoblocking access control configuration.

enabledstring

Enable or disable this feature.

policystring

Policy mode controlling allow/deny behavior.

liststring[]

Comma-separated list of allowed or blocked values.

ipsstring

IP addresses associated with the access control policy.

activestring

Whether this policy is currently enforced.

ipaccessobject

IP address access control configuration.

enabledstring

Enable or disable this feature.

policystring

Policy mode controlling allow/deny behavior.

liststring

Comma-separated list of allowed or blocked values.

ipsstring

IP addresses associated with the access control policy.

activestring

Whether this policy is currently enforced.

useragentobject

User-agent based access control configuration.

enabledstring

Enable or disable this feature.

policystring

Policy mode controlling allow/deny behavior.

liststring

Comma-separated list of allowed or blocked values.

ipsstring

IP addresses associated with the access control policy.

casesensitivestring

Whether user-agent pattern matching is case-sensitive.

activestring

Whether this policy is currently enforced.

listArrstring[]

User-agent filter list as a parsed array.

transcodeobject

Live transcoding configuration for the stream.

ltcinteger

Live transcoding server ID assigned to this stream.

typestring

Type identifier for this stream or object.

enabledboolean

Enable or disable this feature.

isEditableboolean

Whether the transcoding configuration can be edited.

platformsarray

List of configured external restreaming platform entries.

idinteger

Unique numeric identifier.

rtmpstring

RTMP playback or destination URL.

authstring

Whether RTMP publish authentication is enabled.

usernamestring

Username for RTMP authentication.

passwordstring

Password for RTMP publish authentication.

isSRTboolean

keystring

RTMP stream key for the restream platform.

schedulestring

Publishing schedule type.

scheduletimestring

codecstring

Video codec used for the stream.

lengthstring

Maximum stream length in hh:mm:ss format.

relidinteger

dedicatedLTCstring

Whether a dedicated live transcoding server is allocated for this stream.

transcodeobject

Live transcoding configuration for the stream.

ltcinteger

Live transcoding server ID assigned to this stream.

typestring

Type identifier for this stream or object.

enabledboolean

Enable or disable this feature.

isEditableboolean

Whether the transcoding configuration can be edited.

disabledstring

Disabled flag. 0 means active; 1 means disabled.

namestring

Name of the stream.

platform_idinteger

provider_idinteger

Unique identifier of the ad insertion provider record.

video_idstring

messagesobject

Informational messages related to the stream state.

adInsertionstring

Ad insertion configuration for the stream, or null if not configured.

Was this page helpful?