Create ABR Stream

Create a new ABR stream

curl -X POST "https://api.5centscdn.com/v2/streams/abr/new" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "_METHOD": "PUT",
  "name": "james/tae",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "server": "11,211",
  "parentid": 3,
  "platformtype": "",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[noreferer]": "N",
  "domainlock[ips]": "",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list][]": "",
  "geoblock[ips]": "",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "ndvr[enabled]": "Y",
  "ndvr[retention]": 5,
  "record[server]": 1,
  "record[enabled]": "Y",
  "record[retention]": 3,
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[ips]": "",
  "securetoken[keyip]": "N",
  "securetoken[session]": "0",
  "securetoken[timeout]": 3600,
  "securetoken[active]": "Y",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "useragent[ips]": ""
}'

import requests
import json

url = "https://api.5centscdn.com/v2/streams/abr/new"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "_METHOD": "PUT",
  "name": "james/tae",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "server": "11,211",
  "parentid": 3,
  "platformtype": "",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[noreferer]": "N",
  "domainlock[ips]": "",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list][]": "",
  "geoblock[ips]": "",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "ndvr[enabled]": "Y",
  "ndvr[retention]": 5,
  "record[server]": 1,
  "record[enabled]": "Y",
  "record[retention]": 3,
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[ips]": "",
  "securetoken[keyip]": "N",
  "securetoken[session]": "0",
  "securetoken[timeout]": 3600,
  "securetoken[active]": "Y",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "useragent[ips]": ""
}

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

const response = await fetch("https://api.5centscdn.com/v2/streams/abr/new", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "_METHOD": "PUT",
  "name": "james/tae",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "server": "11,211",
  "parentid": 3,
  "platformtype": "",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[noreferer]": "N",
  "domainlock[ips]": "",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list][]": "",
  "geoblock[ips]": "",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "ndvr[enabled]": "Y",
  "ndvr[retention]": 5,
  "record[server]": 1,
  "record[enabled]": "Y",
  "record[retention]": 3,
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[ips]": "",
  "securetoken[keyip]": "N",
  "securetoken[session]": "0",
  "securetoken[timeout]": 3600,
  "securetoken[active]": "Y",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "useragent[ips]": ""
})
});

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

package main

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

func main() {
    data := []byte(`{
  "_METHOD": "PUT",
  "name": "james/tae",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "server": "11,211",
  "parentid": 3,
  "platformtype": "",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[noreferer]": "N",
  "domainlock[ips]": "",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list][]": "",
  "geoblock[ips]": "",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "ndvr[enabled]": "Y",
  "ndvr[retention]": 5,
  "record[server]": 1,
  "record[enabled]": "Y",
  "record[retention]": 3,
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[ips]": "",
  "securetoken[keyip]": "N",
  "securetoken[session]": "0",
  "securetoken[timeout]": 3600,
  "securetoken[active]": "Y",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "useragent[ips]": ""
}`)

    req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/streams/abr/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/abr/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 = '{
  "_METHOD": "PUT",
  "name": "james/tae",
  "codec": "h264",
  "protocols": [
    "HLS"
  ],
  "server": "11,211",
  "parentid": 3,
  "platformtype": "",
  "domainlock[enabled]": "Y",
  "domainlock[policy]": "Y",
  "domainlock[list]": "example.com,docs.example.com",
  "domainlock[noreferer]": "N",
  "domainlock[ips]": "",
  "geoblock[enabled]": "Y",
  "geoblock[policy]": "Y",
  "geoblock[list][]": "",
  "geoblock[ips]": "",
  "ipaccess[enabled]": "Y",
  "ipaccess[policy]": "N",
  "ipaccess[list]": "",
  "ipaccess[ips]": "",
  "ndvr[enabled]": "Y",
  "ndvr[retention]": 5,
  "record[server]": 1,
  "record[enabled]": "Y",
  "record[retention]": 3,
  "securetoken[enabled]": "Y",
  "securetoken[policy]": "D",
  "securetoken[list]": "32862cdb6276e19a",
  "securetoken[ips]": "",
  "securetoken[keyip]": "N",
  "securetoken[session]": "0",
  "securetoken[timeout]": 3600,
  "securetoken[active]": "Y",
  "useragent[enabled]": "Y",
  "useragent[policy]": "Y",
  "useragent[list]": "",
  "useragent[casesensitive]": "N",
  "useragent[ips]": ""
}'

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

{
  "result": "success",
  "message": "Stream Created",
  "stream": {
    "monitoring_id": null,
    "type": "abr",
    "id": 72255,
    "serviceid": 103,
    "name": "james/tae",
    "codec": "h264",
    "ingests": [
      [],
      null
    ],
    "protocols": [
      [
        "HLS"
      ],
      [
        "HLS"
      ]
    ],
    "parentid": null,
    "server": "201",
    "backup": "",
    "dedicatedLTC": "0",
    "hasAdvancedFeatures": "0",
    "monitoring_triggers": null,
    "draft": "0",
    "disabled": "0",
    "created_at": "2026-05-01 04:26:11",
    "updated_at": "2026-05-01 04:26:11",
    "lastseen_at": false,
    "deleted": null,
    "ingestsLock": 0,
    "protocolsLock": 1,
    "status": "Deploying",
    "has": {
      "rtmp": 0,
      "rtsp": 0,
      "hls": 1,
      "dash": 0,
      "rtmpauth": false
    },
    "fms": {
      "server": {
        "country": "North America",
        "meta": {
          "fmsUrl": "rtmp://fms-01-01.5centscdn.com"
        }
      }
    },
    "abr": {
      "streams": 5,
      "hashes": {
        "1": "tae1",
        "2": "tae2",
        "3": "tae3",
        "4": "tae4",
        "5": "tae5"
      }
    },
    "parts": {
      "pp": "james",
      "sn": "tae",
      "full": "jamestae"
    },
    "restream": {},
    "playbackurls": {
      "scheme": "https",
      "url_prefix": "https://stream-abc12-hls-live.stream.example.com",
      "rtmp": "",
      "rtsp": "",
      "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",
          "rtmp": "",
          "rtsp": "",
          "hds": ""
        },
        "videojs": {
          "baseQ": "",
          "base": "https://cdn.example.com/videojs/hls/",
          "hls": "https://cdn.example.com/videojs/hls/aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4",
          "rtmp": "",
          "rtsp": "",
          "hds": ""
        },
        "own": {
          "baseQ": "?showcv=true&title=james/tae",
          "base": "https://cdn.example.com/player/hls/skin1//",
          "hls": "https://cdn.example.com/player/hls/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=james/tae",
          "dash": "https://cdn.example.com/player/dash/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=james/tae"
        }
      },
      "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=james/tae",
            "base": "https://cdn.example.com/player/hls/skin1//",
            "hls": "https://cdn.example.com/player/hls/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=james/tae",
            "dash": "https://cdn.example.com/player/dash/skin1//aHR0cHM6Ly9zdHJlYW0uZXhhbXBsZS5jb20vc2FtcGxlL3N0cmVhbS9wbGF5bGlzdC5tM3U4?showcv=true&title=james/tae"
          }
        },
        "path": {
          "hls": "/james/tae/playlist_dvr.m3u8",
          "dash": "/james/tae/manifest_dvr.mpd"
        },
        "token": {
          "hls": "md5=Q6ViEYDsWUajNWsegkfhdg&path=%2Fjames%2Ftae&expires=1777613184",
          "dash": "md5=Q6ViEYDsWUajNWsegkfhdg&path=%2Fjames%2Ftae&expires=1777613184"
        }
      },
      "hds": ""
    },
    "platformsCount": 0,
    "ssl_enabled": true,
    "hash": "tae",
    "ndvr": {
      "enabled": "Y",
      "retention": "5"
    },
    "securetoken": {
      "enabled": "Y",
      "policy": "D",
      "keyip": "N",
      "list": "32862cdb6276e19a",
      "timeout": 3600,
      "session": "0",
      "ips": "",
      "dirs": null,
      "active": "Y"
    },
    "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": [
        ""
      ]
    },
    "adInsertion": null,
    "record": {
      "enabled": "Y",
      "retention": "3",
      "stream": {
        "id": 72256,
        "type": "record"
      }
    },
    "rtmpauth": {
      "password": "",
      "active": "N"
    },
    "transcode": {
      "ltc": 0,
      "type": "mixed",
      "enabled": false,
      "isEditable": true
    },
    "platforms": [],
    "messages": {}
  },
  "warnings": null,
  "errors": null
}

POST

/streams/abr/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

_METHODstring

Required

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

namestring

Required

Friendly name for this resource.

codecstring

Video codec for the stream. Use h264 or h265.

protocolsarray

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

serverstring

Server ID(s) for the stream. Use comma-separated values for multiple servers.

parentidinteger

Identifier of the parent resource in the hierarchical structure.

platformtypestring

Platform type identifier. Specifies the type of platform associated with the stream.

domainlock[enabled]string

Indicates if domain lock is enabled. Y means enabled, N means disabled.

domainlock[policy]string

The policy for domain access. Y means allow, N means deny.

domainlock[list]string

A comma-separated list of allowed domains for access.

domainlock[noreferer]string

Indicates whether to block referrer headers. Y means block, N means allow.

domainlock[ips]string

A list of IP addresses allowed or blocked based on the domain policy.

geoblock[enabled]string

Indicates if geoblocking is enabled. Y means enabled, N means disabled.

geoblock[policy]string

The policy for geoblocking. Y means block listed locations, N means allow.

geoblock[list][]string

Country codes to block. Examples include AF, GB, US.

geoblock[ips]string

A list of IP addresses associated with the geoblocking rule.

ipaccess[enabled]string

Indicates if IP access control is enabled. Y means enabled, N means disabled.

ipaccess[policy]string

The policy for IP access. Y means allow, N means deny.

ipaccess[list]string

A list of allowed IP addresses for access.

ipaccess[ips]string

A list of IP addresses blocked or allowed based on the policy.

ndvr[enabled]string

Indicates if NDVR is enabled. Y means enabled, N means disabled.

ndvr[retention]integer

The number of days to retain NDVR recordings.

record[server]integer

The DVR server identifier.

record[enabled]string

Indicates if recording is enabled. Y means enabled, N means disabled.

record[retention]integer

The number of days to retain recordings.

securetoken[enabled]string

Indicates if secure token authentication is enabled. Y means enabled, N means disabled.

securetoken[policy]string

The policy for secure token usage. D means default policy.

securetoken[list]string

A secure token identifier used for access control.

securetoken[ips]string

A list of IP addresses associated with secure tokens.

securetoken[keyip]string

Indicates if the token is bound to the IP address. Y means bound, N means not bound.

securetoken[session]string

Indicates whether a session is required for token validation. 0 means no session.

securetoken[timeout]integer

Timeout duration in seconds for secure token validity.

securetoken[active]string

Whether the secure token is currently active. Y means active, N means inactive.

useragent[enabled]string

Indicates if user-agent filtering is enabled. Y means enabled, N means disabled.

useragent[policy]string

The policy for user-agent filtering. Y means allow, N means deny.

useragent[list]string

A list of allowed or blocked user-agent strings.

useragent[casesensitive]string

Indicates whether user-agent matching is case-sensitive. Y means case-sensitive, N means not.

useragent[ips]string

A list of IP addresses associated with user-agent filtering rules.

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

_METHODstring

Required

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

Example:

PUT

namestring

Required

Friendly name for this resource.

Example:

james/tae

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"]

serverstring

Server ID(s) for the stream. Use comma-separated values for multiple servers.

Example:

11,211

parentidinteger

Identifier of the parent resource in the hierarchical structure.

Example:

3

platformtypestring

Platform type identifier. Specifies the type of platform associated with the stream.

Example:

domainlock[enabled]string

Indicates if domain lock is enabled. Y means enabled, N means disabled.

Example:

Y

domainlock[policy]string

The policy for domain access. Y means allow, N means deny.

Example:

Y

domainlock[list]string

A comma-separated list of allowed domains for access.

Example:

example.com,docs.example.com

domainlock[noreferer]string

Indicates whether to block referrer headers. Y means block, N means allow.

Example:

N

domainlock[ips]string

A list of IP addresses allowed or blocked based on the domain policy.

Example:

geoblock[enabled]string

Indicates if geoblocking is enabled. Y means enabled, N means disabled.

Example:

Y

geoblock[policy]string

The policy for geoblocking. Y means block listed locations, N means allow.

Example:

Y

geoblock[list][]string

Country codes to block. Examples include AF, GB, US.

Example:

geoblock[ips]string

A list of IP addresses associated with the geoblocking rule.

Example:

ipaccess[enabled]string

Indicates if IP access control is enabled. Y means enabled, N means disabled.

Example:

Y

ipaccess[policy]string

The policy for IP access. Y means allow, N means deny.

Example:

N

ipaccess[list]string

A list of allowed IP addresses for access.

Example:

ipaccess[ips]string

A list of IP addresses blocked or allowed based on the policy.

Example:

ndvr[enabled]string

Indicates if NDVR is enabled. Y means enabled, N means disabled.

Example:

Y

ndvr[retention]integer

The number of days to retain NDVR recordings.

Example:

5

record[server]integer

The DVR server identifier.

Example:

1

record[enabled]string

Indicates if recording is enabled. Y means enabled, N means disabled.

Example:

Y

record[retention]integer

The number of days to retain recordings.

Example:

3

securetoken[enabled]string

Indicates if secure token authentication is enabled. Y means enabled, N means disabled.

Example:

Y

securetoken[policy]string

The policy for secure token usage. D means default policy.

Example:

D

securetoken[list]string

A secure token identifier used for access control.

Example:

32862cdb6276e19a

securetoken[ips]string

A list of IP addresses associated with secure tokens.

Example:

securetoken[keyip]string

Indicates if the token is bound to the IP address. Y means bound, N means not bound.

Example:

N

securetoken[session]string

Indicates whether a session is required for token validation. 0 means no session.

Example:

0

securetoken[timeout]integer

Timeout duration in seconds for secure token validity.

Example:

3600

securetoken[active]string

Whether the secure token is currently active. Y means active, N means inactive.

Example:

Y

useragent[enabled]string

Indicates if user-agent filtering is enabled. Y means enabled, N means disabled.

Example:

Y

useragent[policy]string

The policy for user-agent filtering. Y means allow, N means deny.

Example:

Y

useragent[list]string

A list of allowed or blocked user-agent strings.

Example:

useragent[casesensitive]string

Indicates whether user-agent matching is case-sensitive. Y means case-sensitive, N means not.

Example:

N

useragent[ips]string

A list of IP addresses associated with user-agent filtering rules.

Example:

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.

parentidstring

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_atboolean

Timestamp when the stream was last detected as active.

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.

rtmpauthboolean

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.

abrobject

streamsinteger

List of live streams.

hashesobject

Map of CDN hostname to stream hashes and playback URLs.

1string

2string

3string

4string

5string

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.

rtmpstring

RTMP playback or destination URL.

rtspstring

RTSP playback URL.

hdsstring

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.

rtmpstring

RTMP playback or destination URL.

rtspstring

RTSP playback URL.

hdsstring

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.

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.

hdsstring

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.

ndvrobject

Network DVR (nDVR) rewind configuration for the stream.

enabledstring

Enable or disable this feature.

retentionstring

Retention period in days (record) or minutes (nDVR).

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.

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.

adInsertionstring

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

recordobject

Recording (DVR) configuration for the stream.

enabledstring

Enable or disable this feature.

retentionstring

Retention period in days (record) or minutes (nDVR).

streamobject

Stream object containing configuration and status details.

idinteger

Unique numeric identifier.

typestring

Type identifier for this stream or object.

rtmpauthobject

Whether RTMP publish authentication is required.

passwordstring

Password for RTMP publish authentication.

activestring

Whether this policy is currently enforced.

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.

platformsstring[]

List of configured external restreaming platform entries.

messagesobject

Informational messages related to the stream state.

warningsstring

Non-fatal warnings returned with the response.

errorsstring

Errors returned with the response.

Was this page helpful?