Add Platform

Add the platform of a push stream

curl -X POST "https://api.5centscdn.com/v2/streams/push/1001/platforms" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "platform[name]": "Custom RTMP",
  "platform[rtmp]": "rtmp://rtmp.5centscdn.com:1935/",
  "platform[key]": "password",
  "platform[auth]": "Y",
  "platform[username]": "admin",
  "platform[password]": "password",
  "platform[ltc]": 0,
  "platform[vprofiles]": 106257,
  "platform[aprofiles]": 106257,
  "platform[filters]": [
    3,
    4
  ],
  "platform[schedule]": "instant",
  "platform[scheduleontime]": "14:00",
  "platform[scheduleondatetime]": "2026-01-01 00:00:00",
  "platform[length]": 40
}'

import requests
import json

url = "https://api.5centscdn.com/v2/streams/push/1001/platforms"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "platform[name]": "Custom RTMP",
  "platform[rtmp]": "rtmp://rtmp.5centscdn.com:1935/",
  "platform[key]": "password",
  "platform[auth]": "Y",
  "platform[username]": "admin",
  "platform[password]": "password",
  "platform[ltc]": 0,
  "platform[vprofiles]": 106257,
  "platform[aprofiles]": 106257,
  "platform[filters]": [
    3,
    4
  ],
  "platform[schedule]": "instant",
  "platform[scheduleontime]": "14:00",
  "platform[scheduleondatetime]": "2026-01-01 00:00:00",
  "platform[length]": 40
}

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

const response = await fetch("https://api.5centscdn.com/v2/streams/push/1001/platforms", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "platform[name]": "Custom RTMP",
  "platform[rtmp]": "rtmp://rtmp.5centscdn.com:1935/",
  "platform[key]": "password",
  "platform[auth]": "Y",
  "platform[username]": "admin",
  "platform[password]": "password",
  "platform[ltc]": 0,
  "platform[vprofiles]": 106257,
  "platform[aprofiles]": 106257,
  "platform[filters]": [
    3,
    4
  ],
  "platform[schedule]": "instant",
  "platform[scheduleontime]": "14:00",
  "platform[scheduleondatetime]": "2026-01-01 00:00:00",
  "platform[length]": 40
})
});

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

package main

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

func main() {
    data := []byte(`{
  "platform[name]": "Custom RTMP",
  "platform[rtmp]": "rtmp://rtmp.5centscdn.com:1935/",
  "platform[key]": "password",
  "platform[auth]": "Y",
  "platform[username]": "admin",
  "platform[password]": "password",
  "platform[ltc]": 0,
  "platform[vprofiles]": 106257,
  "platform[aprofiles]": 106257,
  "platform[filters]": [
    3,
    4
  ],
  "platform[schedule]": "instant",
  "platform[scheduleontime]": "14:00",
  "platform[scheduleondatetime]": "2026-01-01 00:00:00",
  "platform[length]": 40
}`)

    req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/streams/push/1001/platforms", 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/push/1001/platforms')
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 = '{
  "platform[name]": "Custom RTMP",
  "platform[rtmp]": "rtmp://rtmp.5centscdn.com:1935/",
  "platform[key]": "password",
  "platform[auth]": "Y",
  "platform[username]": "admin",
  "platform[password]": "password",
  "platform[ltc]": 0,
  "platform[vprofiles]": 106257,
  "platform[aprofiles]": 106257,
  "platform[filters]": [
    3,
    4
  ],
  "platform[schedule]": "instant",
  "platform[scheduleontime]": "14:00",
  "platform[scheduleondatetime]": "2026-01-01 00:00:00",
  "platform[length]": 40
}'

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

{
  "result": "success",
  "message": "Platform Created",
  "stream": {
    "type": "push",
    "id": 51605,
    "serviceid": 103,
    "name": "kola/deloa",
    "codec": "h264",
    "protocols": [
      [
        "HLS"
      ],
      [
        "HLS"
      ]
    ],
    "parentid": null,
    "server": "201",
    "backup": "",
    "draft": "0",
    "disabled": "0",
    "created_at": "2024-12-30 02:57:15",
    "updated_at": "2024-12-30 03:36:27",
    "lastseen_at": false,
    "deleted": null,
    "protocolsLock": 1,
    "status": "Deploying",
    "has": {
      "rtmp": 0,
      "rtsp": 0,
      "hls": 1,
      "dash": 0,
      "rtmpauth": true
    },
    "fms": {
      "server": {
        "country": "Oceania",
        "meta": {
          "fmsUrl": "rtmp://fms-01-01.5centscdn.com"
        }
      }
    },
    "parts": {
      "pp": "kola",
      "sn": "deloa",
      "full": "koladeloa"
    },
    "restream": {},
    "playbackurls": {
      "scheme": "http",
      "url_prefix": "http://onetwo.5centscdndemo.ca",
      "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://hash-hls-live.5centscdn.com"
        },
        "videojs": {
          "baseQ": "",
          "base": "https://cdn.example.com/videojs/hls/",
          "hls": "https://hash-hls-live.5centscdn.com"
        },
        "own": {
          "hashes": {
            "hash": "4vwupwi1g6ecej9r",
            "hls": "https://hash-hls-live.5centscdn.com",
            "dash": "https://hash-hls-live.5centscdn.com",
            "base64": "aHR0cDovL2V4YW1wbGUuY29tL3BsYXlsaXN0Lm0zdTg=",
            "base64dash": "aHR0cDovL2V4YW1wbGUuY29tL21hbmlmZXN0Lm1wZA=="
          },
          "baseQ": "?showcv=true&title=kola/deloa",
          "base": "https://cdn.example.com/player/hls/skin1/example",
          "hls": "https://hash-hls-live.5centscdn.com",
          "dash": "https://hash-hls-live.5centscdn.com"
        }
      }
    },
    "platformsCount": 1,
    "ssl_enabled": false,
    "hash": "fa7d3f6b626222cd40d75e09ec026da1.sdp",
    "ndvr": {
      "enabled": "Y",
      "retention": "33"
    },
    "securetoken": {
      "enabled": "Y",
      "policy": "F",
      "keyip": "Y",
      "list": "",
      "timeout": 3600,
      "session": "0",
      "ips": "1.1.1.1,2.2.2.2",
      "dirs": null,
      "active": "N"
    },
    "record": {
      "enabled": "Y",
      "retention": "14",
      "stream": null
    },
    "domainlock": {
      "enabled": "Y",
      "policy": "N",
      "list": "",
      "ips": "1.1.1.1,2.2.2.2",
      "noreferer": "Y",
      "active": "Y"
    },
    "geoblock": {
      "enabled": "Y",
      "policy": "N",
      "list": [
        "GB",
        "US"
      ],
      "ips": "1.1.1.1,2.2.2.2",
      "active": "Y"
    },
    "ipaccess": {
      "enabled": "Y",
      "policy": "Y",
      "list": "8.8.8.8,9.9.9.9",
      "ips": "1.1.1.1",
      "active": "Y"
    },
    "useragent": {
      "enabled": "Y",
      "policy": "Y",
      "list": "Array",
      "ips": "1.1.1.1",
      "casesensitive": "Y",
      "active": "Y",
      "listArr": [
        "Mozilla/5.0",
        "Chrome/91.0"
      ]
    },
    "rtmpauth": {
      "password": "passsword",
      "active": "N"
    },
    "transcode": {
      "id": 51605,
      "type": "mixed",
      "ltc": 2,
      "vprofiles": [
        "12345",
        "12345"
      ],
      "aprofiles": [
        "12345"
      ],
      "filters": [
        "3",
        "4"
      ],
      "disabled": "0",
      "warnings": [
        "'source' profile cannot be enabled when filters are active."
      ],
      "enabled": true,
      "count": 2,
      "countRaw": 2,
      "codec": null,
      "profiles": {
        "count": {
          "total": 0
        }
      },
      "isEditable": true
    },
    "platforms": [
      {
        "id": 42086,
        "relid": 51605,
        "name": "Custom RTMP",
        "rtmp": "rtmp://rtmp.5centscdn.com:1935/",
        "key": "password",
        "auth": "Y",
        "username": "admin",
        "password": "password",
        "schedule": "instant",
        "scheduletime": null,
        "length": "00:00",
        "platform_id": 1,
        "provider_id": 0,
        "video_id": "",
        "disabled": "0",
        "transcode": {
          "type": "sd",
          "enabled": false,
          "isEditable": true
        }
      }
    ]
  }
}

POST

/streams/push/{streamid}/platforms

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)

Stream ID

The media type of the request body

Options: application/json

platform[name]string

The name of the platform. Examples include Custom RTMP or YouTube.

platform[rtmp]string

The RTMP URL used for streaming to the platform.

platform[key]string

The stream key required for authentication with the platform.

platform[auth]string

Indicates if authentication is required. Y means enabled, N means not required.

platform[username]string

The username for platform authentication.

platform[password]string

The password for platform authentication, paired with the username.

platform[ltc]integer

A configuration setting related to the platform. 1 means enabled, 0 means disabled.

platform[vprofiles]integer

The video profile identifier used by the platform. Specifies the quality or format of the video stream.

platform[aprofiles]integer

The audio profile identifier used by the platform. Specifies the quality or format of the audio stream.

platform[filters]array

A list of filter IDs applied to the platform stream.

platform[schedule]string

The scheduling type for the platform stream. Values include instant or scheduled.

platform[scheduleontime]string

The specific time for a scheduled stream in hh:mm format. Used when schedule is scheduleontime.

platform[scheduleondatetime]string

The full date and time for a scheduled stream. Used when schedule is scheduleondatetime.

platform[length]integer

The duration of the stream in minutes.

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.

Path Parameters

streamidstring

Required

Stream ID

Example:

1001

Body

application/json

platform[name]string

The name of the platform. Examples include Custom RTMP or YouTube.

Example:

Custom RTMP

platform[rtmp]string

The RTMP URL used for streaming to the platform.

Example:

rtmp://rtmp.5centscdn.com:1935/

platform[key]string

The stream key required for authentication with the platform.

Example:

password

platform[auth]string

Indicates if authentication is required. Y means enabled, N means not required.

Example:

Y

platform[username]string

The username for platform authentication.

Example:

admin

platform[password]string

The password for platform authentication, paired with the username.

Example:

password

platform[ltc]integer

A configuration setting related to the platform. 1 means enabled, 0 means disabled.

Example:

0

platform[vprofiles]integer

The video profile identifier used by the platform. Specifies the quality or format of the video stream.

Example:

106257

platform[aprofiles]integer

The audio profile identifier used by the platform. Specifies the quality or format of the audio stream.

Example:

106257

platform[filters]array

A list of filter IDs applied to the platform stream.

Example:

[3,4]

platform[schedule]string

The scheduling type for the platform stream. Values include instant or scheduled.

Example:

instant

platform[scheduleontime]string

The specific time for a scheduled stream in hh:mm format. Used when schedule is scheduleontime.

Example:

14:00

platform[scheduleondatetime]string

The full date and time for a scheduled stream. Used when schedule is scheduleondatetime.

Example:

2026-01-01 00:00:00

platform[length]integer

The duration of the stream in minutes.

Example:

40

Responses

resultstring

Status of the API response.

messagestring

Human-readable message describing the result.

streamobject

Stream object containing configuration and status details.

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.

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.

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.

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.

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.

hashstring

Short hash or slug used in stream URLs.

hlsstring

HLS playback or player iframe URL.

dashstring

DASH playback or player iframe URL.

base64string

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

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.

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.

recordobject

Recording (DVR) configuration for the stream.

enabledstring

Enable or disable this feature.

retentionstring

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

streamstring

Stream object containing configuration and status details.

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.

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.

idinteger

Unique numeric identifier.

typestring

Type identifier for this stream or object.

ltcinteger

Live transcoding server ID assigned to this stream.

vprofilesstring[]

List of video transcoding profile IDs applied to this stream.

aprofilesstring[]

List of audio transcoding profile IDs applied to this stream.

filtersstring[]

List of transcoding filter IDs applied to this stream.

disabledstring

Disabled flag. 0 means active; 1 means disabled.

warningsstring[]

Non-fatal warnings returned with the response.

enabledboolean

Enable or disable this feature.

countinteger

Number of active transcoding profiles.

countRawinteger

Total number of transcoding profiles including inactive.

codecstring

Video codec used for the stream.

profilesobject

Transcoding profile count summary.

countobject

Number of active transcoding profiles.

totalinteger

Total number of transcoding profiles.

isEditableboolean

Whether the transcoding configuration can be edited.

platformsarray

List of configured external restreaming platform entries.

idinteger

Unique numeric identifier.

relidinteger

namestring

Name of the stream.

rtmpstring

RTMP playback or destination URL.

keystring

RTMP stream key for the restream platform.

authstring

Whether RTMP publish authentication is enabled.

usernamestring

Username for RTMP authentication.

passwordstring

Password for RTMP publish authentication.

schedulestring

Publishing schedule type.

scheduletimestring

lengthstring

Maximum stream length in hh:mm:ss format.

platform_idinteger

provider_idinteger

Unique identifier of the ad insertion provider record.

video_idstring

disabledstring

Disabled flag. 0 means active; 1 means disabled.

transcodeobject

Live transcoding configuration for the stream.

typestring

Type identifier for this stream or object.

enabledboolean

Enable or disable this feature.

isEditableboolean

Whether the transcoding configuration can be edited.

Was this page helpful?