API docs by Redocly

5centsCDN - Livestreams (1.0.0)

Download OpenAPI specification:Download

API for managing Live Streams in 5centsCDN

Contact Support: Email: help@5centscdn.com

List Streams

list all streams

List streams

list streams

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "streams": [
    ]
}

Push Streams

endpoints related to Push streams

Create Push

Create a Push stream

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string

The unique name of the stream or resource. It must be between 4 to 32 characters long and follow the format 'string(4,32)/string(4,32)', e.g., 'hames/duple', 'philip/mope'.

server
integer

The server identifier for the streaming setup, typically representing the server's location. Examples: 20 (Singapore), 2 (Europe), 211 (North America), 209 (Oceania).

codec
string

The video codec used for encoding, which determines the compression and quality of the video. Examples include 'h264', 'vp8', and 'hevc'.

protocols
Array of strings

A list of supported streaming protocols, which define how the stream is delivered. Examples include 'RTMP', 'RTSP', 'HLS', and 'DASH'.

object

Settings for restricting stream access to specific domains.

enabled
string

Indicates whether domain locking is enabled. Use 'Y' for enable or 'N' for disable. E.g., 'Y'.

policy
string

Defines the domain lock policy. Use 'N' for no policy or 'R' for restricted. E.g., 'N'.

list
Array of strings

A list of allowed domains for streaming. E.g., ['www.google.com', 'www.example.com'].

noreferer
string

Allows access with no referer. Use 'Y' to enable and 'N' to disable. E.g., 'Y'.

ips
Array of strings

A list of IPs allowed for domain locking. E.g., ['1.1.1.1', '2.2.2.2'].

object

Settings for restricting access based on geographic locations.

enabled
string

Indicates whether geo-blocking is enabled. Use 'Y' for enable or 'N' for disable. E.g., 'Y'.

policy
string

Defines the geo-block policy. Use 'N' for none, 'B' for block, or 'A' for allow. E.g., 'N'.

list
Array of strings

A list of countries to block or allow based on the policy. Examples include 'GB', 'US', 'FR', and 'NG'.

ips
Array of strings

A list of IPs considered for geo-blocking rules. E.g., ['1.1.1.1', '2.2.2.2'].

object

Settings for limiting or granting stream access based on IPs.

enabled
string

Indicates whether IP access control is enabled. Use 'Y' for 'enable' or 'N' for 'disable'. E.g., 'Y'.

policy
string

Defines the IP access policy. Use 'Y' for whitelist or 'N' for blacklist. E.g., 'Y'.

list
Array of strings

A list of IPs included in the policy. E.g., ['8.8.8.8', '9.9.9.9'].

ips
Array of strings

IPs allowed to bypass access restrictions. E.g., ['1.1.1.1', '2.2.2.2'].

vprofiles
Array of integers

An array of unique IDs representing video profiles for encoding. Example IDs include 14931, 14937.

aprofiles
Array of integers

An array of unique IDs representing audio profiles for encoding. Example IDs include 14931.

filters
Array of integers

An array of unique IDs representing filters applied to the stream. Example IDs include 3, 4.

_METHOD
string

Specifies the HTTP method for the request. Example values include 'GET', 'POST', 'PUT', and 'DELETE'.

draft
integer

Indicates draft mode status. Use 0 for disabled and 1 for enabled. E.g., 0.

Responses

Request samples

Content type
application/json
{
  • "name": "kola/deloa",
  • "server": 209,
  • "codec": "h264",
  • "protocols": [
    ],
  • "domainlock": {
    },
  • "geoblock": {
    },
  • "ipaccess": {
    },
  • "vprofiles": [
    ],
  • "aprofiles": [
    ],
  • "filters": [
    ],
  • "_METHOD": "PUT",
  • "draft": 0
}

Response samples

Content type
application/json
{}

Stream

push list

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1

Page Number

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Stream statistics

Returns the details of a push stream statistics

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "transcode": {
    },
  • "platform": [
    ],
  • "fs": {
    },
  • "status": "Enabled",
  • "lastseen": 1626784500
}

Update status of stream

Update status of stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates whether the stream is disabled.
    • A value of "0" typically means the stream is active or enabled, while other values might indicate it is disabled.
    • Example values: "0" (active stream), "1" (disabled stream).

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Delete Info

Delete the information of push stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream deleted successfully."
}

Update Info

Update the information of push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
server
string
  • Identifies the server being used for the operation.
    • Typically refers to the server ID or address where the stream or process is hosted.
    • Examples of server values:
      • '209': A server identified by ID 209.
      • '192.168.1.1': A server represented by an IP address.
codec
string
  • Specifies the codec used for encoding or decoding the video stream.
    • Commonly used to describe how video or audio is compressed and decompressed.
    • Examples of codec values:
      • 'h264': A widely used video codec for high-definition video.
      • 'vp9': Another popular codec for video streaming.
draft
number
  • Indicates whether the stream or content is in draft mode.
    • Used to determine the status of a process or stream, typically with binary values (0 or 1).
    • Examples of draft values:
      • 0: The content is finalized and not a draft.
      • 1: The content is in draft mode and not yet finalized.

Responses

Request samples

Content type
application/json
{
  • "server": "209",
  • "codec": "h264",
  • "draft": 0
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Stream

Returns the details of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stream": {
    }
}

Update platform

Update the platform of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

platformid
required
string
Example: <string>

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object
  • Contains platform-specific details, including configuration and authentication information.
    • Each key (e.g., '42086') represents a unique platform ID and holds associated settings and metadata.
    • Examples include configurations for streaming platforms such as 'Custom RTMP' or other video providers.
name
string
  • The name of the platform.
    • Provides an identifier for the platform, often user-defined.
    • Examples include:
      • 'Custom RTMP': A custom Real-Time Messaging Protocol streaming platform.
      • 'YouTube': A predefined streaming provider.
rtmp
string
  • The RTMP URL for the platform.
    • Used to establish a connection for streaming live video.
    • Examples include:
      • 'rtmp://live.example.com/app/stream12345': A custom RTMP URL.
      • 'rtmp://youtube.com/live2': An RTMP URL for streaming to YouTube.
key
string
  • The key or password used for authentication on the platform.
    • Typically required for secure access to the streaming server.
    • Examples include:
      • 'password': A simple authentication key.
      • 'secureKey123': A more secure example key.
auth
string
  • Indicates whether authentication is required for the platform.
    • Commonly represented as 'Y' for yes and 'N' for no.
    • Examples include:
      • 'Y': Authentication is required.
      • 'N': Authentication is not required.
username
string
  • The username used for platform authentication.
    • Required if authentication is enabled ('auth' set to 'Y').
    • Examples include:
      • 'admin': A standard administrator account.
      • 'streamer123': A user account for a specific individual.
password
string
  • The password used in conjunction with the username for authentication.
    • Secures access to the platform.
    • Examples include:
      • 'password': A simple password (not recommended).
      • 'P@ssw0rd!': A more secure password example.
vprofiles
number
  • The number of video profiles associated with the platform.
    • Used to manage video quality or encoding settings.
    • Examples include:
      • 0: No video profiles defined.
      • 2: Two profiles available for video streaming.
aprofiles
number
  • The number of audio profiles associated with the platform.
    • Used to manage audio quality or encoding settings.
    • Examples include:
      • 0: No audio profiles defined.
      • 1: One profile available for audio streaming.
schedule
string
  • Indicates the scheduling type for the platform.
    • Defines whether the stream is instant or scheduled at a specific time.
    • Examples include:
      • 'instant': The stream starts immediately.
      • 'scheduled': The stream is scheduled for a later time.
scheduleontime
string
  • Specifies the scheduled time for the stream, if applicable.
    • Empty if 'schedule' is set to 'instant.'
    • Examples include:
      • '10:30 AM': A specific time for the stream to start.
      • '': Indicates no scheduled time.
scheduleondatetime
string
  • Specifies the scheduled date and time for the stream, if applicable.
    • Empty if 'schedule' is set to 'instant.'
    • Examples include:
      • '2025-01-15T10:30:00Z': A full date and time in ISO 8601 format.
      • '': Indicates no scheduled date and time.
provider_id
number
  • Identifies the provider associated with the platform.
    • Used to link the platform to a specific provider or service.
    • Examples include:
      • 0: No provider specified.
      • 2: A provider with ID 2.
video_id
string
  • The ID of the video associated with the platform.
    • Empty if no specific video is linked.
    • Examples include:
      • 'abc123': A unique identifier for a video.
      • '': Indicates no video is linked.

Responses

Request samples

Content type
application/json
{
  • "platform": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Delete Platform

Delete the Platform of push stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

platformid
required
string
Example: <string>

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Update platform status

Status the platform of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

platformid
required
string
Example: <string>

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
integer
  • Indicates the status of the platform, determining whether it is active or inactive.
    • Commonly used to enable or disable a platform.
    • Example values include:
      • 0: The platform is enabled and operational.
      • 1: The platform is disabled and non-operational.

Responses

Request samples

Content type
application/json
{
  • "disabled": 0
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform enabled"
}

Restart platform

Restart the platform of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

platformid
required
integer
Example: 42086

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Restarted"
}

Add platform

Add the platform of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
Array of objects
  • A list of platform configurations, each containing detailed properties.
    • Represents individual platform settings for streaming, authentication, and scheduling.
    • Example platforms include:
      • A custom RTMP streaming platform.
      • A pre-configured platform with specific filters and profiles.
Array
name
string
  • The name of the platform.
    • Identifies the type of platform being used.
    • Examples include:
      • 'Custom RTMP': A user-defined RTMP platform.
      • 'YouTube': A common streaming platform.
rtmp
string
  • The RTMP URL used for streaming.
    • Represents the server address where the stream is sent.
    • Examples include:
      • 'rtmp://live.example.com/app/stream12345': A custom RTMP URL.
      • 'rtmp://youtube.com/live2': A YouTube RTMP URL.
key
string
  • The stream key required for authentication.
    • Ensures only authorized users can stream to the platform.
    • Examples include:
      • 'password': A sample stream key.
      • 'xyz12345': A randomly generated secure stream key.
auth
string
  • Indicates if authentication is required.
    • Possible values include:
      • 'Y': Authentication is enabled.
      • 'N': Authentication is not required.
username
string
  • The username for platform authentication.
    • Used when the platform requires user-based credentials.
    • Examples include:
      • 'admin'.
      • 'streamer123': A custom username for streaming.
password
string
  • The password for platform authentication.
    • Paired with the username for secure access.
    • Examples include:
      • 'password': A basic password.
      • 'securePass2023!': A strong, secure password.
ltc
integer
  • A configuration setting related to the platform.
    • Specific meaning may vary by platform.
    • Examples include:
      • 1: Enabled or active.
      • 0: Disabled or inactive.
vprofiles
integer
  • The video profile identifier used by the platform.
    • Specifies the quality or format of the video stream.
    • Examples include:
      • 106257: A high-definition video profile.
      • 2048: A low-resolution video profile.
aprofiles
integer
  • The audio profile identifier used by the platform.
    • Specifies the quality or format of the audio stream.
    • Examples include:
      • 106257: A high-quality audio profile.
      • 1024: A low-bitrate audio profile.
filters
Array of arrays
  • A list of filters applied to the platform stream.
    • Filters may enhance or modify the stream output.
    • Examples include:
      • [3, 4]: Two active filters.
      • [1, 2, 5]: A set of additional filters.
schedule
string
  • The scheduling type for the platform stream.
    • Determines when the stream will start.
    • Examples include:
      • 'instant': The stream starts immediately.
      • 'scheduled': The stream is set for a specific time.
scheduleontime
string
  • The specific time for a scheduled stream.
    • Used when scheduling is not 'instant.'
    • Examples include:
      • '14:00': A stream scheduled for 2 PM.
      • '09:30': A stream scheduled for 9:30 AM.
scheduleondatetime
string
  • The full date and time for a scheduled stream.
    • Combines date and time for precise scheduling.
    • Examples include:
      • '2025-01-12T14:00:00Z': A UTC-scheduled stream.
      • '2025-01-12T09:30:00+01:00': A time zone-specific stream.
length
integer
  • The duration of the stream in minutes.
    • Specifies the expected length of the stream.
    • Examples include:
      • 40: A 40-minute stream.
      • 90: A 1.5-hour stream.

Responses

Request samples

Content type
application/json
{
  • "platform": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Created",
  • "stream": {
    }
}

Update DVR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the DVR feature is enabled or disabled.
    • Represents the status of the DVR functionality on the platform.
    • Possible values include:
      • 'Y': DVR is enabled.
      • 'N': DVR is disabled.
retention
string
  • Specifies the retention period for the DVR content in days.
    • Determines how long recorded content will be stored before being deleted or archived.
    • Examples include:
      • '33': Content is retained for 33 days.
      • '7': Content is retained for one week.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "33"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Restart Stream

Restart a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

Restore Stream

Restore a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restored",
  • "stream": {
    }
}

Update NDVR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the NDVR (Network Digital Video Recorder) feature is enabled or disabled.
    • The property is represented as a string, where typical values are:
      • 'Y': The NDVR feature is enabled.
      • 'N': The NDVR feature is disabled.
retention
string
  • Specifies the retention period for the NDVR recordings.
    • Represents the duration (in days) that recordings will be retained before being automatically deleted.
    • Example values:
      • '30': Retain recordings for 30 days.
      • '7': Retain recordings for 7 days.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "30"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update RTMPAuth

Update RTMPAuth of push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether RTMP (Real-Time Messaging Protocol) authentication is enabled or disabled.
    • Typical values are:
      • 'Y': Authentication is enabled.
      • 'N': Authentication is disabled.
username
string
  • The username required for RTMP authentication.
    • This is used to authenticate connections to the RTMP server.
    • Example values:
      • 'admin': A common default username for server access.
      • 'stream_user': A user-specific name for authenticated access.
password
string
  • The password required for RTMP authentication.
    • This is paired with the username to establish a secure connection to the RTMP server.
    • Example values:
      • 'password': A default password (should be changed to a secure one).
      • 'strongpassword123': A strong, user-defined password.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "username": "admin",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Secure Token

Update secure token of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled.
    • Typical values are:
      • 'Y': Enabled.
      • 'N': Disabled.
policy
string
  • Specifies the policy type to be applied.
    • Policies may define how rules or actions are enforced.
    • Example values:
      • 'F': Full policy enforcement.
      • 'P': Partial or relaxed policy enforcement.
list
string
  • A unique identifier for a list or set of items to be applied.
    • Typically represents a configuration or settings list.
    • Example values:
      • '9d0c4b0e30cde228': An example of a unique ID.
      • 'abc123xyz456': A hypothetical list identifier.
timeout
string
  • Specifies the timeout period in seconds.
    • This determines the duration before a session or connection expires.
    • Example values:
      • '3600': 1 hour.
      • '7200': 2 hours.
session
string
  • Represents the session configuration setting.
    • May determine whether session handling is enabled or specify session parameters.
    • Example values:
      • '0': No active session.
      • '1': Session active or enabled.
keyip
string
  • Indicates whether IP-based key restrictions are enabled.
    • Helps control access based on the user's IP address.
    • Example values:
      • 'Y': Key restriction by IP is enabled.
      • 'N': Key restriction by IP is disabled.
ips
string
  • A comma-separated list of IP addresses.
    • Defines the IP addresses allowed or restricted under certain policies.
    • Example values:
      • '1.1.1.1,2.2.2.2': A list of two example IPs.
      • '192.168.0.1,10.0.0.1': Example private IP addresses.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "9d0c4b0e30cde228",
  • "timeout": "3600",
  • "session": "0",
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Geo Block

Update the geoblock of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates if the feature is enabled or disabled.
    • 'Y' means enabled, and 'N' means disabled.
    • Example values: 'Y', 'N'.
policy
string
  • Represents the policy status.
    • 'Y' means the policy is active, and 'N' means it is inactive.
    • Example values: 'Y', 'N'.
list
array of strings
  • A list of country codes that are associated with this property.
    • Example values include: 'GB' for Great Britain and 'US' for the United States.
    • Each code represents a specific country or region.
ips
string
  • A list of IP addresses associated with this property.
    • Multiple IP addresses are separated by commas.
    • Example values: '1.1.1.1, 2.2.2.2'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "'Y'",
  • "policy": "'N'",
  • "list": "['GB', 'US']",
  • "ips": "'1.1.1.1, 2.2.2.2'"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Domain Lock

Update the domainlock of a publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the domain lock feature is enabled or disabled.
    • 'Y' means the feature is enabled, and 'N' means it is disabled.
    • Example values: 'Y', 'N'.
policy
string
  • Represents the policy status for domain locking.
    • 'Y' means the policy is active, and 'N' means it is inactive.
    • Example values: 'Y', 'N'.
list
string
  • A comma-separated list of domain names that are associated with this domain lock.
ips
string
  • A comma-separated list of IP addresses allowed to access or modify the domain.
    • Multiple IP addresses can be listed, each separated by a comma.
    • Example values: '1.1.1.1, 2.2.2.2'.
noreferer
string
  • Indicates whether referer checking is enabled for the domain.
    • 'Y' means the referer check is enabled, preventing requests without a valid referer header.
    • 'N' means the referer check is not enabled.
    • Example values: 'Y', 'N'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "'Y'",
  • "policy": "'N'",
  • "list": "'www.google.com,www.example.com'",
  • "ips": "'1.1.1.1, 2.2.2.2'",
  • "noreferer": "'Y'"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update transcode

Update the transcode of a push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
ltc
string
  • Represents the LTC (Long Time Code) setting.
    • This setting is used to control the timing reference for transcoding.
    • The value '2' typically indicates a specific setting, such as a specific time code format.
    • Example values: '1', '2'.
vprofiles
Array of arrays
  • A list of video profiles to be used during transcoding.
    • These profiles define various video quality settings such as resolution and bitrate.
    • The list contains identifiers of specific profiles.
    • Example values: [106257, 109713] (each number corresponds to a predefined video profile).
aprofiles
Array of arrays
  • A list of audio profiles to be used during transcoding.
    • These profiles specify audio quality settings such as codec and bitrate.
    • The list contains identifiers of predefined audio profiles.
    • Example values: [0] (the number corresponds to an audio profile ID, where '0' could be a default profile).
filters
Array of arrays
  • A list of filters to be applied during transcoding.
    • Filters modify or enhance the content in the video/audio stream, such as applying effects or adjustments.
    • Each number represents a specific filter to be applied.
    • Example values: [3, 4] (each number represents a different filter to modify the transcoding process).

Responses

Request samples

Content type
application/json
{
  • "ltc": "'2'",
  • "vprofiles": "[106257, 109713]",
  • "aprofiles": "[0]",
  • "filters": "[3, 4]"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Source

Update the source of a Push stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51605

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
server
string

The server identifier where the stream is hosted, typically representing the server's location. Examples: 20 (Singapore), 2 (Europe), 211 (North America), 209 (Oceania).

Responses

Request samples

Content type
application/json
{
  • "server": "'209'"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Servers

Return the list of servers of push stream

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "'success'",
  • "servers": "{\n 'mediaservers': { ... } \n}",
  • "mediaservers": "{\n '04': { ... },\n '02': { ... },\n '03': { ... },\n '05': { ... },\n '01': { ... }\n}",
  • "04": "{\n 'code': 209,\n 'codeArr': ['209'],\n 'ipaddress': '51.161.197.142',\n 'name': 'Oceania'\n}",
  • "code": "209",
  • "codeArr": "['209']",
  • "ipaddress": "'51.161.197.142'",
  • "name": "'Oceania'",
  • "02": "{\n 'code': '11,211',\n 'codeArr': ['11', '211'],\n 'ipaddress': '148.113.152.95,148.113.152.96',\n 'name': 'North America'\n}",
  • "03": "{\n 'code': 2,\n 'codeArr': ['2'],\n 'ipaddress': '51.210.214.151',\n 'name': 'Europe'\n}",
  • "05": "{\n 'code': 212,\n 'codeArr': ['212'],\n 'ipaddress': '148.113.1.171',\n 'name': 'India'\n}",
  • "01": "{\n 'code': 20,\n 'codeArr': ['20'],\n 'ipaddress': '139.99.121.140',\n 'name': 'Singapore'\n}"
}

Pull Streams

endpoints related to Pull streams

Stream

pull streams list

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Create Pullstream

Create a restream

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name or identifier of the stream or platform.
    • This is usually a string representing the stream name or associated identifier.
    • Example: 'otilor/dongo' could represent a specific stream or service.
codec
string
  • The video codec used for encoding the stream.
    • This defines how the video content is compressed and transmitted.
    • Example: 'h264' is a common codec for video compression.
object
  • Configuration related to the media server.
    • This section defines settings or identifiers for the media server that serves the stream.
    • Example: 'mediaserver' indicates the server ID used for the stream.
mediaserver
integer
  • The unique identifier for the media server.
    • Example: '209' refers to a specific media server in the system.
object
  • Defines the mode of operation for the media server.
    • This indicates the type of streaming or service mode used, like HLS (HTTP Live Streaming) or others.
    • Example: 'mediaserver' can refer to the specific mode like 'hls'.
mediaserver
string
  • The type of media server mode being used.
    • 'hls' indicates the server is set to use HTTP Live Streaming mode.
object
  • URL related to the media server.
    • This field holds URLs that are used to access the media stream from the server.
    • Example: 'mediaserver' key lists the URLs used for accessing the stream.
mediaserver
Array of arrays
  • A list of URLs associated with the media server.
audiofix
string
  • Indicates if audio issues have been addressed or fixed in the stream.
    • 'Y' means audio issues have been fixed, 'N' means no fix has been applied.
restreamtype
string
  • The type of restreaming being applied.
    • This defines whether the stream is being relayed through a media server or another method.
    • Example: 'mediaserver' could indicate that the stream is relayed through a media server.
object
  • Configuration related to domain locking.
    • This feature restricts access to the stream based on domain names.
    • Example: 'enabled' shows whether domain locking is active, and 'list' specifies which domains are allowed.
enabled
string
  • Whether domain locking is enabled.
    • 'Y' means enabled, 'N' means disabled.
policy
string
  • The domain locking policy.
    • 'Y' means a specific policy applies, 'N' means no specific policy is set.
list
string
  • A comma-separated list of allowed domains.
    • Example: 'happyhut.cloud,draftss.com,amazon.in' lists the domains allowed to access the stream.
noreferer
string
  • Indicates if referer headers should be ignored for domain access control.
    • 'Y' means ignore, 'N' means do not ignore.
ips
string
  • A list of IP addresses allowed for domain access.
    • Example: '2.2.2.2,1.1.1.1' lists specific IP addresses that can access the stream.
object
  • Configuration for geographic access control (Geo-blocking).
    • This restricts access to the stream based on geographic locations (countries).
    • Example: 'enabled' shows whether Geo-blocking is active, and 'list' defines which countries are restricted.
enabled
string
  • Whether Geo-blocking is enabled.
    • 'Y' means enabled, 'N' means disabled.
policy
string
  • The Geo-blocking policy.
    • 'Y' means a specific policy applies, 'N' means no specific policy is applied.
list
Array of arrays
  • A list of country codes to block access from.
    • Example: ['AF', 'BS', 'CL'] blocks access from Afghanistan, Bahamas, and Chile.
ips
string
  • A list of IP addresses involved in the geographic access control.
    • Example: '2.2.2.2,1.1.1.1' lists the IP addresses restricted from accessing the stream.
object
  • Configuration for IP-based access control.
    • This restricts or allows access based on specific IP addresses.
    • Example: 'enabled' indicates if IP access control is active, and 'list' defines the allowed or denied IP addresses.
enabled
string
  • Whether IP access control is enabled.
    • 'Y' means enabled, 'N' means disabled.
policy
string
  • The IP access policy.
    • 'Y' means a policy applies, 'N' means no specific policy is set.
list
string
  • A list of allowed or denied IP addresses.
    • Example: '8.8.8.8,2.2.2.2' specifies which IP addresses are allowed or denied.
ips
string
  • A list of specific IP addresses involved in the access control.
    • Example: '1.1.1.1,3.3.3.3' could be used to restrict or allow access based on these IPs.
object
  • Configuration for controlling access based on the user agent string.
    • This controls access based on the browser or application making the request.
    • Example: 'enabled' shows if this feature is active, and 'list' defines acceptable user agent strings.
enabled
string
  • Whether user-agent access control is enabled.
    • 'Y' means enabled, 'N' means disabled.
policy
string
  • The user-agent policy.
    • 'Y' means a policy applies, 'N' means no policy is set.
list
string
  • A list of acceptable or denied user-agent strings.
    • Example: 'chrome;;;firefox;;;hh;;;eferf;;;' specifies which browsers or apps are allowed.
casesensitive
string
  • Whether user-agent matching is case-sensitive.
    • 'Y' means case-sensitive, 'N' means case-insensitive.
ips
string
  • A list of IP addresses associated with user-agent control.
    • Example: '2.2.2.2,1.1.1.1' defines which IP addresses are allowed based on user-agent control.
object
  • Configuration related to token-based security for the stream.
    • This feature involves generating and validating secure tokens for accessing the stream.
    • Example: 'enabled' indicates whether token security is enabled, and 'timeout' sets the time limit for token validity.
enabled
string
  • Whether secure token authentication is enabled.
    • 'Y' means enabled, 'N' means disabled.
policy
string
  • The security policy for the tokens.
    • 'D' means a specific policy applies.
list
string
  • A list of token identifiers.
    • Example: '0d35310bbeb61af1' is a token identifier used for access control.
timeout
integer
  • The timeout duration for token validity.
    • Example: '14583' represents the time in seconds for how long the token is valid.
session
integer
  • Indicates whether a session is required for token validation.
    • '1' means a session is required, '0' means no session.
keyip
string
  • Whether the token is restricted to a specific IP address.
    • 'Y' means restricted to a specific IP, 'N' means not restricted.
ips
string
  • A list of IP addresses allowed for token access.
    • Example: '1.1.1.1,2.2.2.2' restricts access to these IP addresses.
object
  • Configuration for Network Digital Video Recorder (NDVR).
    • This is a system that records live streams for later viewing or retrieval.
    • Example: 'enabled' shows whether NDVR is active, and 'retention' specifies how many days to store recordings.
enabled
string
  • Whether NDVR is enabled.
    • 'Y' means enabled, 'N' means disabled.
retention
integer
  • The number of days to retain the recorded data.
    • Example: '180' means recordings are stored for 180 days.
object
  • Configuration related to the recording of the stream.
    • This defines whether recording is enabled and how long recordings are retained.
    • Example: 'enabled' indicates if recording is active, and 'retention' specifies the number of days recordings are stored.
enabled
string
  • Whether recording is enabled.
    • 'Y' means enabled, 'N' means disabled.
retention
integer
  • The number of days to keep the recordings.
    • Example: '14' means recordings are stored for 14 days.
vprofiles
Array of arrays
  • A list of video profile IDs used for the stream.
    • These IDs define the resolution, bitrate, and other properties of the video.
    • Example: '[14931, 14937]' represents a list of video profile IDs.
aprofiles
Array of arrays
  • A list of audio profile IDs used for the stream.
    • These IDs define the audio quality settings for the stream.
    • Example: '[14931]' represents an audio profile ID.
filters
Array of arrays
  • A list of filters applied to the stream.
    • These filters can be used for purposes like blocking unwanted content or ensuring content meets specific criteria.
    • Example: '[3, 4]' represents filter IDs.
_METHOD
string
  • The HTTP method used for the request.
    • This is typically used to indicate the action (e.g., PUT, POST).
    • Example: 'PUT' indicates an update operation.
draft
integer
  • Indicates whether the content is a draft.
    • '0' means it is not a draft, '1' means it is a draft.
platformtype
string
  • Specifies the type of platform the stream is associated with.
    • This could be a specific type like 'rtmp' or 'hls'.
    • Example: '' means no specific type has been set.
Array of objects
  • A list of platforms associated with the stream.
    • Each platform contains details like URL, authentication, and scheduling information.
    • Example: A platform entry might include 'rtmp' or 'hls' type.
Array
id
integer
  • The unique identifier for the platform.
    • Example: '42020' represents a specific platform.
relid
integer
  • The related identifier for the platform.
    • Example: '50591' represents a related entity.
name
string
  • The name of the platform.
    • Example: 'rtmp' represents a platform using RTMP streaming protocol.
rtmp
string
  • The URL or endpoint for RTMP streaming.
    • Example: 'rtmp://fms-01-02.5centscdn.com/janamtv' is the RTMP endpoint.
key
string
  • The key used for the stream.
    • Example: 'live' could represent the stream key.
auth
string
  • Indicates whether authentication is required.
    • 'Y' means authentication is required, 'N' means it is not.
username
string
  • The username for authentication.
    • Example: 'admin' could be used for authentication.
password
string
  • The password for authentication.
    • Example: 'password123' could be the stream password.
schedule
string
  • Defines the stream scheduling.
    • 'instant' means the stream starts immediately, 'scheduled' means it is set for a specific time.
scheduletime
null
  • The time set for scheduled streams.
    • If null, no scheduled time is specified.
length
string
  • The length of the stream.
    • Example: '00:00' means the stream length is not defined.
platform_id
integer
  • The identifier of the platform.
    • Example: '1' could represent a specific platform ID.
provider_id
integer
  • The identifier for the service provider.
video_id
string
  • The identifier for the video stream.
    • Example: '12345' represents the video ID.
disabled
string
  • Indicates whether the platform is disabled.
    • '0' means not disabled, '1' means disabled.
transcode
object
  • Transcoding settings for the platform.
    • Example: 'type' defines the transcoding quality, 'enabled' defines if transcoding is active.

Responses

Request samples

Content type
application/json
{
  • "name": "otilor/dongo",
  • "codec": "h264",
  • "server": {
    },
  • "mode": {
    },
  • "url": {},
  • "audiofix": "Y",
  • "restreamtype": "mediaserver",
  • "domainlock": {
    },
  • "geoblock": {
    },
  • "ipaccess": {
    },
  • "useragent": {
    },
  • "securetoken": {
    },
  • "ndvr": {
    },
  • "record": {
    },
  • "vprofiles": [
    ],
  • "aprofiles": [
    ],
  • "filters": [
    ],
  • "_METHOD": "PUT",
  • "draft": 0,
  • "platformtype": "",
  • "platform": [
    ]
}

Response samples

Content type
application/json
{}

Stream statistics

Returns the details of a pull stream statistics

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "fs": {
    },
  • "platform": [
    ],
  • "status": "Enabled",
  • "lastseen": "11 seconds ago"
}

Update Source

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
restreamtype
string
  • Indicates the type of restream being used.
    • Defines the source or mechanism of the stream.
    • Example values: 'mediaserver', 'cloudstream'.
object
  • Contains details about the server used for restreaming.
    • Typically includes the server identifier or address.
mediaserver
string
  • Represents the identifier of the media server.
    • Used to point to the specific media server in the system.
    • Example values: '206', '123'.
object
  • Defines the operational mode of the media server.
    • Determines the streaming protocol or delivery mechanism.
mediaserver
string
  • Indicates the streaming mode supported by the media server.
    • Common values are related to protocols.
    • Example values: 'hls', 'dash', 'rtmp'.
object
  • Contains the URLs for accessing the media server streams.
    • Includes one or more URLs that clients can use.
mediaserver
Array of arrays
audiofix
string
  • Indicates whether the audio fix feature is enabled.
    • 'Y' means enabled, 'N' means disabled.
    • Example values: 'Y', 'N'.

Responses

Request samples

Content type
application/json
{
  • "restreamtype": "mediaserver",
  • "server": {
    },
  • "mode": {
    },
  • "url": {},
  • "audiofix": "Y"
}

Response samples

Content type
application/json
{}

Update Domain Lock

Update domain lock of a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled.
    • 'Y' represents enabled, while 'N' represents disabled.
    • Example values: 'Y', 'N'.
policy
string
  • Defines the policy mode in use.
    • Typically used to configure behavior or rules for a feature.
    • Example values: 'N' (No policy), 'Y' (Policy applied).
list
string
  • A comma-separated list of domains that are included in the configuration.
    • Represents allowed or restricted domains depending on context.
    • Example values: 'happyhut.cloud,draftss.com,amazon.in', 'example.com,example2.com'.
noreferer
string
  • Specifies whether requests without a referer are allowed.
    • 'Y' means requests without a referer are permitted, 'N' means they are not.
    • Example values: 'Y', 'N'.
active
string
  • A comma-separated list of active IP addresses.
    • Represents the IPs currently engaged or active in the configuration.
    • Example values: '2.2.2.2,1.1.1.1', '192.168.1.1,10.0.0.1'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "happyhut.cloud,draftss.com,amazon.in",
  • "noreferer": "Y",
  • "active": "2.2.2.2,1.1.1.1"
}

Response samples

Content type
application/json
{}

Update SecureToken

Update secure token of a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled.
    • 'Y' means the feature is enabled, while 'N' means it is disabled.
    • Example values: 'Y', 'N'.
policy
string
  • Specifies the policy type applied to the feature.
    • Common values may include 'D' (default policy) or other policy codes.
    • Example values: 'D', 'N'.
list
string
  • A unique identifier or list used for specific configurations or rules.
    • Often represents a hash, ID, or a group of related items.
    • Example values: '0d35310bbeb61af1', 'abcd1234efgh5678'.
timeout
string
  • Defines the timeout duration, typically in seconds.
    • Determines how long a session or operation remains active before timing out.
    • Example values: '14583', '300'.
session
string
  • Indicates the session configuration, often numeric.
    • Represents session-specific settings or identifiers.
    • Example values: '1', '2'.
keyip
string
  • Specifies whether the IP key mechanism is enabled or disabled.
    • 'Y' means the mechanism is enabled, while 'N' means it is disabled.
    • Example values: 'Y', 'N'.
ips
string
  • A comma-separated list of IP addresses associated with the configuration.
    • Typically used for whitelisting, blacklisting, or specific IP-based rules.
    • Example values: '1.1.1.1,2.2.2.2', '192.168.1.1,10.0.0.1'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "D",
  • "list": "0d35310bbeb61af1",
  • "timeout": "14583",
  • "session": "1",
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{}

Update Geo Block

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled.
    • 'Y' means the feature is enabled, while 'N' means it is disabled.
    • Example values: 'Y', 'N'.
policy
string
  • Specifies the policy type applied to the feature.
    • Common values may include 'N' (no restrictions) or other policy codes.
    • Example values: 'N', 'D'.
list
Array of arrays
  • A list of country codes .
    • Typically used for geolocation-based restrictions, filtering, or access control.
    • Example values: ['AF', 'BS', 'CL'].
ips
string
  • A comma-separated list of IP addresses.
    • Represents addresses used for whitelisting, blacklisting, or specific access rules.
    • Example values: '2.2.2.2,1.1.1.1', '192.168.0.1,10.0.0.1'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "2.2.2.2,1.1.1.1"
}

Response samples

Content type
application/json
{}

Update DVR

Update DVR of a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the DVR (Digital Video Recorder) functionality is enabled or disabled.
    • 'Y' means the feature is enabled, while 'N' means it is disabled.
    • Example values: 'Y', 'N'.
retention
string
  • Specifies the retention period for the DVR content, measured in days.
    • Represents how long the recorded video will be stored before it is deleted.
    • Example values: '14', '30', '7'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "14"
}

Response samples

Content type
application/json
{}

Restart

Restart a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

Restore

Restore a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update transcode

Update the transcode of a pull stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
ltc
string
  • Represents the live transcoding configuration.
    • Indicates the current transcoding state or configuration level.
    • Example values:
      • '2': Signifies a specific transcoding setup.
      • '1': Could represent another predefined configuration.
vprofiles
array of strings
  • Lists video profile IDs used for transcoding.
    • Each ID corresponds to a predefined video profile.
    • Example values:
      • '106257': A profile with specific resolution and bitrate settings.
      • '109713': Another predefined profile for a different quality level.
aprofiles
array of integers
  • Lists audio profile IDs used for transcoding.
    • Each ID corresponds to a predefined audio profile.
    • Example values:
      • 0: Could indicate a default or base audio profile.
      • 1: Another predefined profile for enhanced audio quality.
filters
array of integers
  • Contains IDs of filters applied during the transcoding process.
    • Filters may modify the video or audio output, such as resizing or applying visual effects.
    • Example values:
      • 3: Could represent a filter for video scaling.
      • 4: Could signify a filter for noise reduction.

Responses

Request samples

Content type
application/json
{
  • "ltc": "2",
  • "vprofiles": [
    ],
  • "aprofiles": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Update NDVR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the NDVR (Network Digital Video Recorder) functionality is enabled.
    • 'Y': NDVR is active and available for use.
    • 'N': NDVR is disabled or not in use.
retention
string
  • Specifies the retention period for recorded content, measured in days.
    • Determines how long the NDVR stores video recordings before deletion.
    • Example values:
      • '14': Recordings are kept for 14 days.
      • '30': Recordings are kept for 30 days.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "14"
}

Response samples

Content type
application/json
{}

Add platform

Add the platform of a pull stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
Array of objects
  • A list of platforms where the stream will be published.
    • Each platform contains configuration details for connecting and streaming.
    • Examples include RTMP endpoints, authentication details, and transcoding options.
Array
name
string
  • The name of the platform.
    • Identifies the platform being used, such as a custom RTMP server or a predefined platform.
    • Example values:
      • 'Custom RTMP'
      • 'YouTube Live'
rtmp
string
  • The RTMP URL where the stream is published.
    • Used by streaming clients to send live video content.
    • Example values:
      • 'rtmp://live.example.com/app/stream12345'
      • 'rtmp://youtube.com/live/streamkey'
key
string
  • The stream key or password for authentication.
    • Used to secure the stream connection to the platform.
    • Example values:
      • 'password'
      • 'streamkey1234'
auth
string
  • Indicates whether authentication is required to connect to the platform.
    • 'Y': Authentication is enabled and required.
    • 'N': No authentication is required.
username
string
  • The username for authenticating to the platform.
    • Required if authentication (auth) is enabled.
    • Example values:
      • 'admin'
      • 'streamuser123'
password
string
  • The password for authenticating to the platform.
    • Required if authentication (auth) is enabled.
    • Example values:
      • 'password'
      • 'securekey1234'
ltc
integer
  • The live-to-cut latency in seconds.
    • Specifies the delay between the live stream and the published stream.
    • Example values:
      • 1 (one second delay)
      • 5 (five seconds delay)
vprofiles
integer
  • The ID of the video profile used for transcoding.
    • Determines the video settings such as resolution and bitrate.
    • Example values:
      • 106257 (HD profile)
      • 109713 (SD profile)
aprofiles
integer
  • The ID of the audio profile used for transcoding.
    • Determines the audio settings such as codec and bitrate.
    • Example values:
      • 106257 (AAC profile)
      • 109713 (MP3 profile)
filters
Array of arrays
  • A list of filter IDs applied to the stream.
    • Filters are used to modify the video or audio, such as applying effects or adjustments.
    • Example values:
      • [3, 4] (specific filter IDs)
      • [1, 2] (alternative filter IDs)
schedule
string
  • Specifies the schedule type for the stream.
    • Determines when the stream should begin.
    • Example values:
      • 'instant': Starts streaming immediately.
      • 'timed': Starts streaming at a scheduled time.
scheduleontime
string
  • Specifies the exact time for starting the stream if scheduled.
    • Used when the schedule is set to a specific time.
    • Example values:
      • '14:30'
      • '10:00'
scheduleondatetime
string
  • Specifies the exact date and time for starting the stream if scheduled.
    • Used for precise scheduling.
    • Example values:
      • '2025-01-11T14:30:00Z'
      • '2025-01-12T10:00:00Z'
length
string
  • Specifies the duration of the scheduled stream.
    • Indicates how long the stream will run.
    • Example values:
      • '02:00' (two hours)
      • '00:30' (thirty minutes)

Responses

Request samples

Content type
application/json
{
  • "platform": [
    ]
}

Response samples

Content type
application/json
{}

Restart platform

Restart the platform of a pull stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

platformid
required
integer
Example: 42107

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Restarted"
}

Update platform status

Status the platform of a pull stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

platformid
required
integer
Example: 42107

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
any

Responses

Request samples

Content type
application/json
{
  • "disabled": null
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform enabled"
}

Update platform

Update the platform of a pull stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

platformid
required
integer
Example: 42107

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
Array of objects
  • A list of platform configurations.
    • Each item in the array represents an individual platform and its related settings.
    • Example includes platforms like RTMP or HLS streaming configurations.
Array
id
integer
  • A unique identifier for the platform.
    • Used to differentiate between various platforms.
    • Example values:
      • 42096: Represents a specific platform instance.
      • 52021: Represents another platform instance.
relid
integer
  • An identifier linking this platform to another resource, such as a transcode or streaming configuration.
    • Provides relational context.
    • Example values:
      • 51642: Links to a specific transcode configuration.
      • 61651: Links to another resource.
name
string
  • The name of the platform.
    • Typically represents the streaming protocol used.
    • Example values:
      • 'rtmp': Indicates RTMP streaming.
      • 'hls': Indicates HLS streaming.
rtmp
string
  • The RTMP URL for the streaming platform.
    • Specifies the endpoint for live stream uploads.
    • Example values:
      • 'rtmp://fms-01-02.5centscdn.com/janamtv': A valid RTMP endpoint.
      • 'rtmp://live.example.com/stream': Another example URL.
key
string
  • The stream key used for authentication or identification on the platform.
    • Example values:
      • 'live': A generic live stream key.
      • 'stream123': Another example stream key.
auth
string
  • Indicates whether authentication is required for the platform.
    • Possible values:
      • 'Y': Authentication is required.
      • 'N': Authentication is not required.
username
string
  • The username used for authentication if required by the platform.
    • Example values:
      • 'admin': A typical administrator username.
      • 'stream_user': Another example username.
password
string
  • The password used for authentication if required by the platform.
    • Example values:
      • 'password123': A sample password.
      • 'securepass': Another example password.
schedule
string
  • The scheduling type for the platform stream.
    • Indicates when the stream will start.
    • Example values:
      • 'instant': Start the stream immediately.
      • 'scheduled': Start the stream at a predefined time.
scheduletime
string or null
  • The scheduled time for the stream if applicable.
    • Null if no specific time is scheduled.
    • Example values:
      • '2025-01-11T10:30:00Z': A specific scheduled time.
      • null: Indicates no scheduling time.
length
string
  • The total duration of the stream.
    • Usually formatted as HH:MM.
    • Example values:
      • '00:00': Indicates no length is set.
      • '01:30': Indicates a 1-hour 30-minute stream.
platform_id
integer
  • A unique identifier for the platform type.
    • Example values:
      • 1: Represents a specific platform type.
      • 2: Represents another platform type.
provider_id
integer
  • A unique identifier for the streaming provider.
    • Example values:
      • 0: Indicates no provider is associated.
      • 101: Indicates a specific provider.
video_id
string
  • A unique identifier for the video associated with the platform.
    • Typically empty if no video is linked.
    • Example values:
      • '12345abc': Represents a specific video ID.
      • '': Indicates no video ID is set.
disabled
string
  • Indicates whether the platform is disabled.
    • Example values:
      • '0': The platform is enabled.
      • '1': The platform is disabled.
transcode
object
  • Transcoding settings for the platform.
    • Includes details such as type, enabled status, and editability.
    • Example values:
      • { "type": "sd", "enabled": false, "isEditable": true }.

Responses

Request samples

Content type
application/json
{
  • "platform": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Delete Platform

Delete the Platform of pull stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

platformid
required
integer
Example: 42107

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Stream

Return the details of a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update Info

Update information of a restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
codec
string
  • Specifies the video codec used for encoding the stream.
    • This determines the format in which the video is compressed and transmitted.
    • Example values:
      • 'h264': A widely used codec for high-quality video streaming.
      • 'vp8': An alternative codec often used for web videos.
draft
string
  • Indicates the draft status of the stream.
    • This property is typically used to specify whether the stream is a draft or finalized.
    • Example values:
      • '0': The stream is not in draft status (published).
      • '1': The stream is in draft status (not finalized).
platformtype
string
  • Specifies the platform type for the stream.
    • This field defines the platform through which the stream is delivered.
    • Example values:
      • 'rtmp': A protocol commonly used for live streaming.
      • 'hls': A widely used protocol for adaptive bitrate streaming.
protocols
Array of arrays
  • A list of protocols supported by the stream.
    • These are the methods or technologies used to transmit the stream across different networks.
    • Example values:
      • ['RTMP', 'RTSP']: A set of protocols for delivering real-time media.
      • ['DASH', 'HLS_FMP4']: Streaming protocols for adaptive bitrate video delivery.

Responses

Request samples

Content type
application/json
{
  • "codec": "h264",
  • "draft": "0",
  • "platformtype": "RTMP",
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{}

Delete Info

Delete information of a restream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51642

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Servers

Return the list of servers of pull stream

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "servers": {
    }
}

Update Status of Stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 54214
Request Body schema: application/json
disabled
integer
  • Indicates whether the pull stream is enabled or disabled.
    • A value of 0 means the stream is enabled and actively pulling content.
    • A value of 1 means the stream is disabled and not in use.

Responses

Request samples

Content type
application/json
{
  • "disabled": 0
}

Response samples

Content type
application/json
{}

Multi Bitrate Push Streams

endpoints related to MBR streams

ABR

List Multi Bitrate Push streams

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Create ABR

Create a new ABR stream

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name identifier for the resource.
  • It represents the unique identifier with slashes and indicates a specific resource.
  • Examples: "james/take", "smith/do".
server
integer
  • Server identifier number.
  • It denotes the server ID associated with the resource.
  • Examples: 209, 312.
codec
string
  • Codec used for encoding.
  • Indicates the encoding format for multimedia data.
  • Examples: "h264", "vp9".
parentid
integer
  • Identifier of the parent resource.
  • It refers to the ID of the parent resource in the hierarchical structure.
  • Examples: 3, 7.
object
  • Domain lock settings for security.
  • Controls access based on allowed domains and IP addresses.
  • Example of enabled: "Y".
enabled
string
  • Indicates if domain lock is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
policy
string
  • The policy for domain access.
  • A value of "Y" means allow, and "N" means deny.
list
Array of arrays
  • A list of allowed domains for access.
  • Example: Domains like "happyhut.cloud", "draftss.com", etc. are allowed.
noreferer
string
  • Indicates whether to block referrer headers.
  • A value of "Y" means block referrers, and "N" means allow.
ips
Array of arrays
  • A list of IP addresses allowed or blocked based on the policy.
  • Example: Specific IPs like "2.2.2.2" and "1.1.1.1".
object
  • Geoblocking configuration.
  • Restricts access based on geographical locations.
  • Example of enabled: "Y".
enabled
string
  • Indicates if geoblocking is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
policy
string
  • The policy for geoblocking.
  • A value of "Y" means block access from the listed locations, and "N" means allow.
list
Array of arrays
  • A list of country codes or regions to block.
  • Example: Countries like "AF", "BS", and "CL" are blocked.
ips
Array of arrays
  • A list of IP addresses associated with the geoblocking rule.
  • Example: Specific IPs like "2.2.2.2" and "1.1.1.1".
object
  • IP access control settings.
  • Manages allowed and restricted IP addresses.
  • Example of enabled: "Y".
enabled
string
  • Indicates if IP access control is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
policy
string
  • The policy for IP access.
  • A value of "Y" means allow, and "N" means deny.
list
Array of arrays
  • A list of allowed IP addresses for access.
  • Example: IPs like "8.8.8.8", "2.2.2.2".
ips
Array of arrays
  • A list of IP addresses blocked or allowed based on the policy.
  • Example: Specific IPs like "1.1.1.1" and "3.3.3.3".
object
  • User-agent filtering settings.
  • Controls access based on user-agent strings.
  • Example of enabled: "Y".
enabled
string
  • Indicates if user-agent filtering is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
policy
string
  • The policy for user-agent filtering.
  • A value of "Y" means allow, and "N" means deny.
list
string
  • A list of allowed or blocked user-agent strings.
  • Example: "chrome;;;firefox;;;hh;;;eferf;;;" represents a set of allowed user-agents.
casesensitive
string
  • Indicates whether the user-agent matching is case-sensitive.
  • A value of "Y" means case-sensitive, and "N" means not case-sensitive.
ips
Array of arrays
  • A list of IP addresses associated with user-agent filtering rules.
  • Example: Specific IPs like "2.2.2.2", "1.1.1.1".
object
  • Secure token settings for authentication.
  • Manages token-based authentication with additional security measures.
  • Example of enabled: "Y".
enabled
string
  • Indicates if secure token authentication is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
policy
string
  • The policy for secure token usage.
  • A value of "D" means deny, and "A" means allow.
list
Array of arrays
  • A list of secure tokens.
  • Example: Token IDs like "0d35310bbeb61af1".
timeout
integer
  • Timeout duration in seconds for secure token validity.
  • Example: 14583 seconds.
session
integer
  • The session duration.
  • Example: 1 for active session.
keyip
string
  • Indicates if the token is bound to the IP address.
  • A value of "Y" means bound, and "N" means not bound.
ips
Array of arrays
  • A list of IP addresses associated with secure tokens.
  • Example: Specific IPs like "1.1.1.1", "2.2.2.2".
object
  • NDVR (Network Digital Video Recorder) configuration.
  • Enables or disables NDVR and specifies retention period in days.
  • Example of enabled: "Y".
enabled
string
  • Indicates if NDVR is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
retention
integer
  • The number of days to retain NDVR recordings.
  • Example: 180 days.
object
  • Recording settings.
  • Controls recording functionality and specifies retention period in days.
  • Example of enabled: "Y".
enabled
string
  • Indicates if recording is enabled.
  • A value of "Y" means enabled, and "N" means disabled.
retention
integer
  • The number of days to retain recordings.
  • Example: 14 days.
_METHOD
string
  • HTTP method for the request.
  • Specifies the HTTP method to use for the API request.
  • Example: "PUT".
draft
integer
  • Draft status indicator.
  • Indicates whether the resource is in draft mode (0 for not a draft, 1 for draft).
  • Examples: 0, 1.
platformtype
string
  • Platform type identifier.
  • Specifies the type of platform associated with the resource.
  • Example: "web", "mobile".

Responses

Request samples

Content type
application/json
{
  • "name": "james/take",
  • "server": 209,
  • "codec": "h264",
  • "parentid": 3,
  • "domainlock": {
    },
  • "geoblock": {
    },
  • "ipaccess": {
    },
  • "useragent": {
    },
  • "securetoken": {
    },
  • "ndvr": {
    },
  • "record": {
    },
  • "_METHOD": "PUT",
  • "draft": 0,
  • "platformtype": ""
}

Response samples

Content type
application/json
{}

Update status of stream

Update status of stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates whether the stream is disabled or enabled.
    • A value of "0" means the stream is enabled and operational.
    • A value of "1" means the stream is disabled and not available.
    • This property is typically used to manage the status of a stream in a system or platform.
    • Examples: "0" (enabled), "1" (disabled).

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{}

Update Geo Block

Update Geoblock of ABR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or setting is enabled.
    • A value of "Y" means the feature is active and operational.
    • A value of "N" means the feature is disabled and not in use.
    • Examples: "Y" (enabled), "N" (disabled).
policy
string
  • Represents the policy configuration for the setting.
    • A value of "Y" might indicate an allow policy, and "N" could indicate a deny policy.
    • Policies are often used to define access or behavior rules.
    • Examples: "Y" (allow policy), "N" (deny policy).
list
Array of arrays
  • A list of specific items or codes related to the setting.
    • For instance, this could be a list of countries or regions associated with a policy.
    • Each item in the list represents a valid code or identifier.
    • Examples: ["AF" (Afghanistan), "BS" (Bahamas), "CL" (Chile)].
ips
string
  • A comma-separated string of IP addresses related to the setting.
    • These IPs could represent either allowed or restricted addresses based on the policy.
    • Each IP address is formatted in standard IPv4 notation.
    • Examples: "2.2.2.2,1.1.1.1" (two specific IP addresses).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "2.2.2.2,1.1.1.1"
}

Response samples

Content type
application/json
{}

Update Domain Lock

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled or disabled.
    • A value of "Y" means the feature is active and operational.
    • A value of "N" means the feature is disabled and not in use.
    • Examples: "Y" (enabled), "N" (disabled).
policy
string
  • Specifies the policy setting for the feature.
    • A value of "Y" might indicate an allow policy, while "N" could indicate a deny policy.
    • Policies define the behavior or access control rules.
    • Examples: "Y" (allow policy), "N" (deny policy).
list
string
  • A comma-separated list of domain names associated with the feature.
    • Each domain represents a specific website or endpoint included in the configuration.
    • Useful for domain whitelisting, blacklisting, or similar purposes.
    • Examples: "www.google.com,www.test.com" (two specific domains).
noreferer
string
  • Indicates whether referrer information is blocked.
    • A value of "Y" means referrer information is not sent, enhancing privacy.
    • A value of "N" means referrer information is included in requests.
    • Examples: "Y" (referrer blocked), "N" (referrer included).
ips
string
  • A comma-separated string of IP addresses related to the feature.
    • These IP addresses could represent allowed or restricted addresses, depending on the policy.
    • Each IP address follows the standard IPv4 format.
    • Examples: "2.2.2.2,1.1.1.1" (two specific IP addresses).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "www.google.com,www.test.com",
  • "noreferer": "Y",
  • "ips": "2.2.2.2,1.1.1.1"
}

Response samples

Content type
application/json
{}

Update RTMP Auth

Update RTMP auth of ABR

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether RTMP authentication is enabled or disabled.
    • A value of "Y" means authentication is required for RTMP connections.
    • A value of "N" means authentication is not required.
    • Examples: "Y" (authentication enabled), "N" (authentication disabled).
username
string
  • The username required for RTMP authentication.
    • This username is used in combination with the password to verify the user.
    • It must be unique and securely stored.
    • Examples: "stream_user", "admin_rtmp".
password
string
  • The password required for RTMP authentication.
    • Used in combination with the username to grant access.
    • Should be strong and kept secure to prevent unauthorized access.
    • Examples: "securePa$$w0rd", "stream1234".

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "username": "username",
  • "password": "password"
}

Response samples

Content type
application/json
{}

Update Record

Update Record ABR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the recording feature is enabled or disabled.
    • A value of "Y" means the recording feature is active and operational.
    • A value of "N" means the recording feature is disabled and not in use.
    • Examples: "Y" (enabled), "N" (disabled).
retention
string
  • Specifies the number of days the recorded data will be retained.
    • The value is typically a positive integer representing days.
    • Helps define the storage duration for compliance or operational needs.
    • Examples: "30" (retain recordings for 30 days), "90" (retain recordings for 90 days).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "30"
}

Response samples

Content type
application/json
{}

Update Ndvr

Update Ndvr ABR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the NDVR (Network Digital Video Recording) feature is enabled or disabled.
    • A value of "Y" means the NDVR feature is active and operational.
    • A value of "N" means the NDVR feature is disabled and not in use.
    • Examples: "Y" (enabled), "N" (disabled).
retention
string
  • Specifies the number of days recorded content will be retained in the NDVR system.
    • This value is typically a positive integer representing the duration in days.
    • Helps define storage policies for managing recorded video data.
    • Examples: "14" (retain recordings for 14 days), "30" (retain recordings for 30 days).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "14"
}

Response samples

Content type
application/json
{}

Restart Stream

Restart ABR

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

Restore Stream

Restore ABR Stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Delete Info

Delete information of ABR stream.To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream deleted successfully."
}

ABR List

Returns the details of an abr stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 54216

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update Info

Update information of ABR stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51691

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
draft
string
  • Indicates whether the stream is in draft mode or published.
    • A value of "0" typically means the stream is not a draft (published).
    • A value of "1" may indicate the stream is in draft mode (unpublished and editable).
    • Examples: "0" (published), "1" (draft).
platformtype
string
  • Specifies the type of platform associated with the stream.
    • Typically used to categorize or specify the platform's target audience or functionality.
    • An empty string may indicate that the platform type is unspecified or irrelevant.
    • Examples: "web", "mobile", "" (unspecified).
server
string
  • Represents the server ID or identifier where the stream is hosted.
    • Typically used to manage or direct the stream to the correct server for processing.
    • Examples: "209" (specific server ID), "101" (alternative server ID).
codec
string
  • Specifies the codec used for encoding the stream.
    • The codec determines how the video or audio data is compressed and transmitted.
    • Common codecs include "h264" for video compression and others depending on the use case.
    • Examples: "h264" (commonly used video codec), "vp9" (alternative codec).
parentid
string
  • Refers to the ID of the parent stream or entity associated with this stream.
    • Used to link the stream to a higher-level entity or category for organizational purposes.
    • Examples: "3" (specific parent ID), "5" (alternative parent ID).
protocols
Array of arrays
  • A list of streaming protocols supported by the stream.
    • Protocols define how the stream is delivered to the end users.
    • Common examples include "DASH" (Dynamic Adaptive Streaming over HTTP) and "HLS" (HTTP Live Streaming).
    • Examples: ["DASH", "HLS"] (supports both protocols), ["RTMP"] (supports RTMP only).

Responses

Request samples

Content type
application/json
{
  • "draft": "0",
  • "platformtype": "",
  • "server": "209",
  • "codec": "h264",
  • "parentid": "3",
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{}

Servers List

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "servers": {
    }
}

DVR

endpoints related to DVR streams

DvrStream

List DVR streams

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "streams": [
    ]
}

Dvr Stream statistics

Return the details of a DVR stream statistics.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 1

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "0": null,
  • "1": null
}

Update status of stream

Update status of stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates whether the feature or service is disabled.
    • A value of '0' means the feature or service is enabled.
    • A value of '1' means the feature or service is disabled.
    • Example values:
      • '0': The service or feature is active and operational.
      • '1': The service or feature is inactive and unavailable.

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Domain Lock

Update Domainlock of a record stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether domain lock is enabled or disabled.
    • A value of 'Y' means domain lock is enabled.
    • A value of 'N' means domain lock is disabled.
    • Example values:
      • 'Y': Domain lock is active, restricting access to specific domains.
      • 'N': Domain lock is not active, and unrestricted access is allowed.
policy
string
  • Specifies the policy associated with the domain lock.
    • A value of 'Y' indicates that the policy is enforced.
    • A value of 'N' indicates that the policy is not enforced.
    • Example values:
      • 'Y': The policy is active, and domains or IP addresses are restricted.
      • 'N': The policy is inactive, and no restrictions are applied.
list
string
  • A comma-separated list of allowed or blocked domains.
    • This list determines which domains are permitted or restricted for the service.
    • Example values:
ips
string
  • A comma-separated list of IP addresses.
    • This list defines the allowed or blocked IP addresses that can access the service.
    • Example values:
      • '1.1.1.1,2.2.2.2': Specifies two IP addresses allowed or blocked based on the policy.
      • '192.168.0.1': A single IP address entry.
noreferer
string
  • Indicates whether the 'Referer' HTTP header is allowed.
    • A value of 'Y' means the 'Referer' header is restricted or not sent.
    • A value of 'N' means the 'Referer' header is allowed.
    • Example values:
      • 'Y': The 'Referer' header is blocked or not sent to prevent domain or IP leakage.
      • 'N': The 'Referer' header is allowed to pass along with the request.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "Y",
  • "list": "www.google.com,www.test.com",
  • "ips": "1.1.1.1,2.2.2.2",
  • "noreferer": "Y"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Secure Token

Update Secure token of record stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the secure token feature is enabled or disabled.
    • A value of 'Y' means the secure token is enabled.
    • A value of 'N' means the secure token is disabled.
    • Example values:
      • 'Y': The secure token feature is active, providing an added layer of security.
      • 'N': The secure token feature is not active.
policy
string
  • Specifies the policy associated with the secure token.
    • A value of 'F' means the policy is 'Fixed'.
    • A value of 'D' means the policy is 'Dynamic'.
    • Example values:
      • 'F': The policy is fixed, with a predefined secure token.
      • 'D': The policy is dynamic, with changing secure tokens.
list
string
  • A list of identifiers associated with the secure token.
    • These identifiers are used to link the secure token to specific actions or resources.
    • Example values:
      • 'ea747727c5ec8e7d': A unique identifier representing a resource or action tied to the secure token.
      • 'abc123456': Another identifier for linking the secure token.
timeout
string
  • The time duration (in seconds) that the secure token remains valid.
    • After this duration, the token expires, and a new one is required.
    • Example values:
      • '3600': Token expires after one hour.
      • '600': Token expires after 10 minutes.
session
string
  • Defines the session duration or the number of requests the token is valid for.
    • A value of '0' indicates that the session is not limited by the number of requests.
    • Example values:
      • '0': Token is valid for an unlimited number of requests until the timeout period.
      • '5': Token expires after 5 requests.
keyip
string
  • Indicates whether the IP address is tied to the secure token.
    • A value of 'Y' means the token is IP-bound, only allowing the token to be used from a specific IP address.
    • A value of 'N' means the token is not tied to a specific IP address.
    • Example values:
      • 'Y': Token can only be used from the specified IP address.
      • 'N': Token can be used from any IP address.
ips
string
  • A list of IP addresses that are authorized to use the secure token.
    • These IP addresses are allowed to access resources protected by the secure token.
    • Example values:
      • '1.1.1.1,2.2.2.2': Two specific IP addresses are authorized to use the token.
      • '192.168.0.1': A single IP address authorized for token usage.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "ea747727c5ec8e7d",
  • "timeout": "3600",
  • "session": "0",
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Geo Block

Update geo block of record stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether geoblocking is enabled or disabled.
    • Geoblocking restricts or allows access to content based on geographical location.
    • A value of 'Y' means that geoblocking is enabled, while 'N' means it is disabled.
    • Example values:
      • 'Y': Geoblocking is active, restricting or allowing access based on location.
      • 'N': Geoblocking is not active, allowing unrestricted access regardless of location.
policy
string
  • Specifies the policy used to control access based on location.
    • A value of 'N' indicates that no specific policy is enforced, while 'Y' would signify an enforced policy.
    • Example values:
      • 'N': No specific access restrictions are in place based on geographical location.
      • 'Y': Access is restricted or allowed based on the defined policy for geoblocking.
list
Array of arrays
  • A list of country codes that are affected by geoblocking.
    • Each code represents a country or region. Access from these countries may be blocked or allowed based on the policy.
    • Example values:
      • ['AF', 'AL']: Afghanistan and Albania are part of the geoblocking list, either blocked or allowed.
      • ['US', 'CA']: United States and Canada are part of the geoblocking list, either blocked or allowed.
ips
string
  • A list of IP addresses that are restricted or allowed based on geoblocking.
    • These IP addresses are either blocked or permitted from accessing the content.
    • Example values:
      • '1.1.1.1,2.2.2.2': These two IP addresses are subject to the geoblock policy, either allowed or blocked.
      • '192.168.0.1': A single IP address restricted or allowed based on the geoblocking rules.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update DVR Export

Update DVR Export of record stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
zoneid
string
  • A unique identifier for the zone where the DVR export occurs.
    • This ID is used to categorize or organize different parts of the system or network.
    • Example values:
      • '1616': A zone ID for a specific area in the system.
      • '1024': A zone ID for a different area or system configuration.
folder
string
  • The directory or path where the DVR export files will be saved.
    • This is where the system will store exported files.
    • Example values:
      • '/test': A folder located under the root directory, named 'test'.
      • '/exports/dvr/': A folder specifically designated for DVR exports.
filename
string
  • The name of the file to be generated during the DVR export.
    • This typically includes dynamic elements such as start and end times for better identification.
    • Example values:
      • 'name-start-end': A filename that includes placeholders for the start and end times.
      • 'export_data_2025.csv': A CSV file for exported data from a specific year.
start
string
  • The start time of the event being exported, represented as a Unix timestamp.
    • A Unix timestamp is a number representing the seconds that have elapsed since January 1, 1970.
    • Example values:
      • '1735513200': A specific start time in the Unix timestamp format.
      • '1617288000': Another start time in the Unix timestamp format.
end
string
  • The end time of the event being exported, also represented as a Unix timestamp.
    • This timestamp marks the time when the event ends.
    • Example values:
      • '1735531200': A specific end time in the Unix timestamp format.
      • '1617300000': Another end time in the Unix timestamp format.

Responses

Request samples

Content type
application/json
{
  • "zoneid": "1616",
  • "folder": "/test",
  • "filename": "name-start-end",
  • "start": "1735513200",
  • "end": "1735531200"
}

Response samples

Content type
application/json
{
  • "zoneid": "1616",
  • "folder": "/test",
  • "filename": "name-start-end",
  • "start": "1735513200",
  • "end": "1735531200",
  • "result": "error",
  • "progressUrl": "http://example.com/progress"
}

Update DVR Auto Export

Update DVR Auto Export of record stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates whether the DVR auto export is disabled.
    • A value of '0' typically means the feature is enabled, and '1' means it is disabled.
    • Example values:
      • '0': The feature is enabled.
      • '1': The feature is disabled.
period
string
  • Specifies the period of time (in minutes) between auto export events.
    • This can be set to determine how often the export occurs.
    • Example values:
      • '30': Auto export occurs every 30 minutes.
      • '60': Auto export occurs every hour.
zoneid
string
  • A unique identifier for the zone where the auto export occurs.
    • Zones help in organizing or categorizing different parts of the system or network.
    • Example values:
      • '1616': A zone ID indicating a specific area within the system.
      • '1024': Another zone identifier for a different part of the system.
folder
string
  • The path to the directory where the auto export files will be saved.
    • This represents the location in the file system or application structure.
    • Example values:
      • '/': The root directory of the file system.
      • '/exports/dvr/': A folder specifically designated for DVR export files.
filename
string
  • The name of the file to be created during the auto export process.
    • This typically includes information that helps identify the content of the file.
    • Example values:
      • 'name-start-end': A filename format that includes a start and end time.
      • 'export_data_2025.csv': A CSV file for exported data from a specific year.

Responses

Request samples

Content type
application/json
{
  • "disabled": "0",
  • "period": "30",
  • "zoneid": "1616",
  • "folder": "/",
  • "filename": "name-start-end"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Restore Stream

Restore record stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restored",
  • "stream": {
    }
}

Restart Stream

Restart record stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

DvrStream

Return the details of a DVR stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stream": {
    }
}

DvrStream

Update information of a record stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
draft
string
  • Indicates whether the item is in a draft state or not.
    • A value of '0' typically means the item is not in a draft state and is ready for use or publication.
    • Example values:
      • '0': The item is not a draft and is finalized.
      • '1': The item is in a draft state and not yet finalized.
platformtype
string
  • Describes the type of platform the item is associated with.
    • This could refer to the technology or platform the item supports or is part of.
    • Example values:
      • 'Web': The platform is a web-based system.
      • 'Mobile': The platform is a mobile application.
      • 'Desktop': The platform is a desktop application.
protocols
Array of arrays
  • A list of video streaming protocols that are supported or used by the item.
    • Protocols define how media is transmitted and streamed across networks.
    • Example values:
      • ['DASH', 'HLS']: The item supports both DASH and HLS streaming protocols.
      • ['RTMP']: The item only supports the RTMP protocol for streaming.

Responses

Request samples

Content type
application/json
{
  • "draft": "0",
  • "platformtype": "",
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

DvrStream

Delete information of a record stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51738

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Delayed Stream

Delayedstreams

List Delayed streams

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "'success'",
  • "streams": [
    ]
}

Source Streams

Return the parents of a Delayed stream

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "parents": [
    ]
}

Delete Info

Delete informations of a delayed stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream deleted"
}

Update Info

Update informations of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
draft
string
  • Indicates the draft status of the item.
    • A value of "0" typically represents a published or final version, while other values (e.g., "1") might indicate a draft or in-progress state.
    • Useful for distinguishing between versions in workflows or content management systems.
platformtype
string
  • Specifies the type of platform or environment related to the item.
    • This can be used to categorize or filter items based on the platform they are associated with.
    • Common examples might include "web", "mobile", or "desktop".
timeshift
string
  • Represents a time shift or offset value, often in seconds.
    • It can be used for scheduling, playback adjustments, or other time-based operations.
    • For example, a value of "31553" might represent an offset of 31,553 seconds (approximately 8 hours and 45 minutes).

Responses

Request samples

Content type
application/json
{
  • "draft": "0",
  • "platformtype": "web",
  • "timeshift": "31553"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Stream

Return Delayed streams

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stream": {
    }
}

Delete Platform

Delete the Platform of delayed stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

platformid
required
integer
Example: 42118

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Update platform

Update the platform of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

platformid
required
integer
Example: 42117

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
platform
object
  • Represents the configuration details for a streaming platform.
    • Includes settings for RTMP URL, authentication, profiles, scheduling, and associated video or provider identifiers.

Responses

Request samples

Content type
application/json
{
  • "platform": { }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Update platform status

Status the platform of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

platformid
required
integer
Example: 42117

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
integer
  • Indicates whether the platform is enabled or disabled.
    • A value of '0' typically means the platform is enabled, while a value of '1' indicates it is disabled.
    • For example:
      • '0': The platform is active and operational.
      • '1': The platform is inactive and not operational.
    • This property is useful for toggling the operational state of the platform

Responses

Request samples

Content type
application/json
{
  • "disabled": 0
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform enabled"
}

Restart platform

Restart the platform of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

platformid
required
integer
Example: 42117

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Restarted"
}

Add platform

Add the platform of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object
  • Contains the details of the platform configuration.
    • Represents a streaming platform with various configurations for accessing the service.
    • Includes properties related to platform name, credentials, streaming setup, scheduling, and filters.
name
string
  • The name of the platform.
    • This is typically used for identifying the platform.
    • Example values could be the service's custom name or type of service like 'Custom RTMP Playlist'.
rtmp
string
  • The RTMP URL used for streaming to the platform.
    • This URL is where the stream will be pushed from the encoder or streaming service.
    • Example values could be URLs provided by streaming services or custom RTMP endpoints.
key
string
  • The key used for authenticating and securing the RTMP stream.
    • Often a password or stream key that allows access to stream on the platform.
    • Example values include: stream keys or authentication tokens.
auth
string
  • Indicates if authentication is required for streaming.
    • 'Y' means authentication is required, and 'N' means it's not.
    • Example values are 'Y' or 'N'.
username
string
  • The username used for authenticating to the streaming platform.
    • Typically used with the password for login or access control.
    • Example values might include admin or a user-specific name.
password
string
  • The password associated with the username for authentication.
    • Used to verify the identity of the user for streaming access.
    • Example values could include 'password' or any other secure password.
ltc
integer
  • A flag that indicates whether Linear Time Code (LTC) is enabled or not.
    • A value of 1 means LTC is enabled, and 0 means it's disabled.
    • Example values could be 1 for enabled or 0 for disabled.
vprofiles
integer
  • The video profiles assigned to the stream.
    • Represents the ID or identifier of video profiles configured for streaming.
    • Example values could be numbers representing specific profiles like '106257' or '123456'.
aprofiles
integer
  • The audio profiles assigned to the stream.
    • Represents the ID or identifier of audio profiles configured for streaming.
    • Example values could be numbers representing specific profiles like '106257' or '123456'.
filters
Array of arrays
  • A list of filters applied to the stream.
    • Each filter corresponds to a specific processing effect applied to the video/audio.
    • Example values are the IDs of filters, such as '[3, 4]'.
schedule
string
  • Indicates the scheduling type for the stream.
    • 'instant' means the stream will start immediately.
    • Other values may include scheduled times or recurring schedules.
    • Example values are 'instant' or 'scheduled'.
scheduleontime
string
  • The specific time at which the stream should start, if applicable.
    • Only used if 'schedule' is set to a time-based value.
    • Example values could be a time in 24-hour format like '14:00' or empty if not used.
scheduleondatetime
string
  • The specific datetime for the stream to be scheduled, if applicable.
    • Only used if 'schedule' is set to a date-time-based value.
    • Example values could be '2025-12-25T14:00:00' or empty if not used.
length
integer
  • The length of the stream in minutes.
    • This represents how long the stream is scheduled to run.
    • Example values could be 40, 60, or other integer values representing stream duration.

Responses

Request samples

Content type
application/json
{
  • "platform": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Created",
  • "stream": {
    }
}

Restart Stream

Restart Delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

Restore Stream

Restore Delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restored",
  • "stream": {
    }
}

Update Domain Lock

Update domainlock of a delayed stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether a feature or service is enabled or disabled.
    • The value 'Y' means enabled, and 'N' would mean disabled.
    • Example values: 'Y' for enabled, 'N' for disabled.
policy
string
  • Specifies the status of a particular policy.
    • The value 'Y' means the policy is active, and 'N' means it is not active.
    • Example values: 'Y' for active policy, 'N' for inactive policy.
list
string
  • A list of URLs that are part of a specific configuration or allowed sources.
noreferer
string
  • Indicates whether the 'Referer' header should be excluded or included in requests.
    • 'Y' means the referer header is excluded, and 'N' means it is included.
    • Example values: 'Y' for exclusion, 'N' for inclusion.
ips
string
  • A list of IP addresses that are part of a configuration or allowed sources.
    • Multiple IP addresses are separated by commas.
    • Example values: '1.1.1.1,2.2.2.2' represents two allowed IP addresses, while '192.168.0.1' would represent a single IP address.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "Y",
  • "list": "www.google.com,www.example.com",
  • "noreferer": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Geo Block

Update Geo block of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether a feature or service is enabled or disabled.
    • The value 'Y' means enabled, and 'N' would mean disabled.
    • Example values: 'Y' for enabled, 'N' for disabled.
policy
string
  • Specifies the status of a particular policy.
    • The value 'Y' means the policy is active, and 'N' means it is not active.
    • Example values: 'Y' for active policy, 'N' for inactive policy.
list
Array of arrays
  • A list of items, in this case, countries or regions represented by their two-letter ISO country codes.
    • Each entry in the list represents a country or region.
    • Example values: 'AF' represents Afghanistan, 'AL' represents Albania.
ips
string
  • A list of IP addresses that are part of a configuration or allowed sources.
    • Multiple IP addresses are separated by commas.
    • Example values: '1.1.1.1,2.2.2.2' represents two allowed IP addresses, while '192.168.0.1' would represent a single IP address.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update Secure Token

Update secure token of a delayed stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether this feature is enabled or not.
    • 'Y' means enabled, 'N' means disabled.
    • This property controls the activation state of the feature.
policy
string
  • Defines the policy setting for the feature.
    • 'Y' could mean a specific policy is active, 'N' means no policy is set.
    • It controls the level of enforcement for the feature's security settings.
list
string
  • A list of items that apply to the feature.
    • It could represent IDs, user names, or other identifiers.
    • In this case, it holds a unique identifier (e.g., 'd6bc2b66a1e5515e').
timeout
string
  • Specifies the timeout duration in seconds.
    • This value represents how long the system waits before timing out.
    • For example, a timeout of 3600 means the timeout lasts for 1 hour.
session
string
  • Indicates the session count or identifier.
    • '0' typically means no active session, and other numbers could indicate the session ID.
    • This value helps track user sessions or activity.
keyip
string
  • Determines if the key IP address feature is enabled.
    • 'Y' means it is enabled, and 'N' means it is not.
    • This feature might restrict access to specific IP addresses for security reasons.
ips
string
  • A comma-separated list of IP addresses allowed or restricted by this feature.
    • In this case, it lists the IP addresses '1.1.1.1' and '2.2.2.2' as valid or restricted addresses.
    • This helps define which IPs are allowed or denied access based on the configuration.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "d6bc2b66a1e5515e",
  • "timeout": "3600",
  • "session": "0",
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Update status of stream

Update status of stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates whether the stream is disabled or not.
    • '0' means the stream is enabled, and '1' would mean the stream is disabled.
    • This property controls whether the stream is actively available or turned off.

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Stream statistics

Return Delayed streams statistics

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "0": null
}

Scheduled Playlist

Streams

scheduledplaylist.

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Stream Statistics

Return details of the stream statistics

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "0": null
}

Stream playlist statistics

Return details of the stream playlist statistics

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51730

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Update Secure Token

Update secure token of a scheduled playlist.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or not.
    • This property is used to toggle the state of a service.
    • Example values include:
      • "Y" for enabled.
      • "N" for disabled.
policy
string
  • Defines the policy or rule applied to the service.
    • This could represent different operational policies such as permissions or access rules.
    • Example values include:
      • "D" for a specific policy type, like a default policy.
      • "C" for another policy type, like a custom policy.
list
string
  • Represents a unique identifier for a list or group.
    • This is typically used to link to a set of related data or entries.
    • Example values include:
      • "1a0f3ac765ff6ec8" for a specific list identifier.
      • "3b1f3ac866ff7dc9" for another list identifier.
timeout
string
  • The duration for which the service will wait or stay active before timing out.
    • This is typically in seconds and dictates how long the system waits before considering the session or process as timed out.
    • Example values include:
      • "3600" for one hour timeout.
      • "120" for a two-minute timeout.
session
string
  • Indicates the session ID or state.
    • This is used to track the session status.
    • Example values include:
      • "0" for an inactive or non-existent session.
      • "1" for an active session.
keyip
string
  • Indicates whether the IP address is tied to a specific key.
    • This helps in tracking or restricting access based on IP and key.
    • Example values include:
      • "Y" for enabled, meaning the IP is tied to a key.
      • "N" for disabled, meaning no IP-key binding.
ips
string
  • A comma-separated list of IP addresses.
    • Represents a set of IP addresses associated with the service or configuration.
    • Example values include:
      • "1.1.1.1,2.2.2.2" for two specific IP addresses.
      • "192.168.0.1,10.0.0.1" for a different set of IP addresses.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "D",
  • "list": "1a0f3ac765ff6ec8",
  • "timeout": "3600",
  • "session": "0",
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{}

Update RTMPAuth

Update RTMP auth of a scheduled playlist.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Represents the state of the feature or service.
    • This property determines if the feature or service is active.
    • Example values include:
      • "true" indicating that the feature is enabled.
      • "false" indicating that the feature is disabled.
username
string
  • Represents the username used for authentication or identification.
    • This is typically a unique identifier for the user within the system.
    • Example values include:
      • "john_doe" for a user with that username.
      • "admin" for an administrative user.
password
string
  • Represents the password associated with the username.
    • This is used for authenticating the user during the login process.
    • Example values include:
      • "password123" as a basic password.
      • "SecurePass!2025" as a more complex password.

Responses

Request samples

Content type
application/json
{
  • "enabled": "true",
  • "username": "john_doe",
  • "password": "password123"
}

Response samples

Content type
application/json
{}

Update Geo Block

Update geoblock of scheduled playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Represents whether the feature or service is enabled.
    • This property indicates if the feature or service is active or not.
    • Example values include:
      • "Y" meaning the feature is enabled.
      • "N" meaning the feature is disabled.
policy
string
  • Represents the policy status related to the feature or service.
    • This can dictate how the feature operates or behaves based on its value.
    • Example values include:
      • "Y" meaning the policy is active.
      • "N" meaning the policy is inactive.
list
Array of strings
  • A list of country codes or other identifiers relevant to the feature.
    • This array represents specific items or identifiers used in the system.
    • Example values include:
      • ["AF", "DZ"] representing Afghanistan and Algeria.
      • ["US", "CA"] representing the United States and Canada.
ips
string
  • A string of IP addresses separated by commas.
    • This property represents the allowed or blocked IPs, depending on the feature's context.
    • Example values include:
      • "1.1.1.1,2.2.2.2" for a list of two IP addresses.
      • "192.168.0.1,10.0.0.1" for local network IP addresses.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2"
}

Response samples

Content type
application/json
{}

Update Domain Lock

Update domain lock of scheduled playlist.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Represents whether the feature or service is enabled.
    • This property indicates if the feature or service is active or not.
    • Example values include:
      • "Y" meaning the feature is enabled.
      • "N" meaning the feature is disabled.
policy
string
  • Represents the policy status related to the feature or service.
    • This can dictate how the feature operates or behaves based on its value.
    • Example values include:
      • "Y" meaning the policy is active.
      • "N" meaning the policy is inactive.
list
string
  • A string containing a list of URLs, separated by commas.
ips
string
  • A string of IP addresses separated by commas.
    • This property represents the allowed or blocked IPs, depending on the feature's context.
    • Example values include:
      • "1.1.1.1,2.2.2.2" for a list of two IP addresses.
      • "192.168.0.1,10.0.0.1" for local network IP addresses.
noreferer
string
  • Indicates whether the referer header is allowed or blocked.
    • This property controls if the referer header is sent in requests.
    • Example values include:
      • "Y" meaning the referer header is allowed.
      • "N" meaning the referer header is blocked.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "www.google.com,www.test.com",
  • "ips": "1.1.1.1,2.2.2.2",
  • "noreferer": "Y"
}

Response samples

Content type
application/json
{}

Update transcode

Update the transcode of a scheduled stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
ltc
string
  • Represents the LTC.
    • This could refer to a specific value used in a system to identify a particular item or record.
    • Example values include:
      • "1" as an identifier for one item.
      • "2" for another item in the context.
vprofiles
Array of strings
  • An array of strings representing profile identifiers.
    • This property stores the IDs of specific profiles, such as video profiles or user profiles.
    • Example values include:
      • "106257", "106256" representing two different profile IDs.
      • "107258", "107259" for other profile IDs.
aprofiles
Array of strings
  • An array of strings representing profile identifiers for another category or context.
    • This property stores a list of profile IDs, likely for approval or active profiles.
    • Example values include:
      • "106257" for a specific profile ID.
      • "107258" for a different profile ID.
filters
Array of strings
  • An array of strings representing filter IDs.
    • This property contains a list of filter IDs that can be applied in the context, such as filtering data or selecting items.
    • Example values include:
      • "3", "4" representing two filters that can be applied.
      • "1", "2" for different filter options.

Responses

Request samples

Content type
application/json
{
  • "ltc": "1",
  • "vprofiles": [
    ],
  • "aprofiles": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{}

Restore Stream

Restore a scheduled playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Create Scheduled Playlist

Create new scheduled playlist

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
notused
Array of strings
  • A list of values that are not currently used in the context.
    • This array stores deprecated or obsolete values.
    • Example values include:
      • "parent", "/", "" (different placeholders).
      • "unused_value", "none", "" (other possible unused values).
parent
integer
  • Represents the parent ID associated with the current object.
    • This value is likely used to link the current item to a parent entity in the system.
    • Example values include:
      • 1616 as a reference ID.
      • 2020 for another parent reference.
newzonemode
string
  • A string representing the mode or method for a new zone.
    • It indicates the configuration or mode type for a specific context, such as HTTP or another protocol.
    • Example values include:
      • "http" for HTTP mode.
      • "https" for a secure HTTPS mode.
name
string
  • The name or identifier for the current entity or object.
    • This string value represents a unique name that identifies the entity.
    • Example values include:
      • "floppy-driver" as the name.
      • "printer-config" for another entity's name.
preroll
string
  • Indicates whether preroll functionality is enabled.
    • This value represents a boolean-like state where 'Y' indicates 'enabled' and any other value indicates 'disabled'.
    • Example values include:
      • "Y" for enabled.
      • "N" for disabled.
loop
string
  • A string indicating the looping behavior of the entity.
    • It specifies how an entity (such as a video or event) should behave when it finishes.
    • Example values include:
      • "repeat" for repeating the entity.
      • "none" for no repetition.
object
file
Array of strings
  • An array representing a list of file paths.
    • These paths indicate the location of files that are relevant to the current entity or process.
    • Example values include:
      • "/videos/S1 E2.mp4" for a video file.
      • "/audio/track1.mp3" for an audio file.
object
file
Array of strings
  • An array representing the durations for specific files.
    • These values represent the length or time of files in a specific context.
    • Example values include:
      • "0,0" for a file with no duration.
      • "5,30" for a file that lasts 5 minutes and 30 seconds.
filescount
integer
  • An integer representing the count of files associated with the current entity.
    • This number indicates how many files are involved in the context.
    • Example values include:
      • 1 for a single file.
      • 3 for multiple files.
_METHOD
string
  • Represents the HTTP method used in the request.
    • This value indicates what type of request is being made, such as PUT, POST, GET, etc.
    • Example values include:
      • "PUT" for a PUT request.
      • "POST" for a POST request.
draft
integer
  • An integer indicating whether the item is a draft or published.
    • 0 typically represents a draft, and 1 represents a published state.
    • Example values include:
      • 0 for draft.
      • 1 for published.
platformtype
string
  • A string representing the platform type.
    • This value indicates the platform to which the entity belongs, such as a web, mobile, or desktop platform.
    • Example values include:
      • "" for no specified platform.
      • "web" for a web platform.
type
string
  • A string representing the type of the current entity.
    • This value categorizes the entity, such as a file or an object.
    • Example values include:
      • "file" for file entities.
      • "image" for image entities.

Responses

Request samples

Content type
application/json
{
  • "notused": [
    ],
  • "parent": 1616,
  • "newzonemode": "http",
  • "name": "floppy-driver",
  • "preroll": "Y",
  • "loop": "repeat",
  • "files": {
    },
  • "durations": {
    },
  • "filescount": 1,
  • "_METHOD": "PUT",
  • "draft": 0,
  • "platformtype": "",
  • "type": "file"
}

Response samples

Content type
application/json
{}

Restart Stream

Restart scheduled playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

Stream playlist

Return details of the stream playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 50784

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "0": null
}

Create Playlist

Create new playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
parent
integer
  • An integer representing the parent identifier.
    • This is usually used to associate the current object with a parent object.
    • Example values:
      • 50784: A valid parent ID that links the current object to its parent.
name
string
  • A string representing the name of the object.
    • This could be a descriptive name or identifier for the object.
    • Example values:
      • "test": A name that could represent a test object.
      • "example-file": A name that could represent a file used for demonstration.
type
string
  • A string indicating the type of the object.
    • This describes what kind of entity the object is.
    • Example values:
      • "file": Represents a file object.
      • "folder": Could represent a folder or directory.
schedule
string
  • A string indicating the scheduling method for the object.
    • This defines how the object is scheduled for execution or action.
    • Example values:
      • "scheduleondatetime": A scheduling method based on a specific date and time.
      • "repeating": A schedule that repeats periodically.
scheduleondatetime
string
  • A string representing the exact date and time for scheduling.
    • This is used when schedule is set to scheduleondatetime.
    • Example values:
      • "2025-01-03 00:01:01": A specific date and time.
      • "2024-12-25 12:00:00": Another date and time example.
repeatfor
integer
  • An integer that specifies how many times the object should repeat.
    • This is used when repetition is required in scheduling.
    • Example values:
      • 1: The object should repeat once.
      • 5: The object should repeat 5 times.
loop
string
  • A string indicating how the loop should behave.
    • This defines whether the object loops and how often.
    • Example values:
      • "onetime": The object will only execute once.
      • "always": The object will execute repeatedly or until stopped.
files
object
  • An object containing file-related data.
    • This stores details about the files associated with the current object.
    • Example values include a list of file paths.
    • Example values:
      • {"file": ["/SampleVideo.mp4"]}: A file path for a video.
      • {"file": ["/image.png"]}: A file path for an image.
durations
object
  • An object specifying durations related to the files.
    • This can represent time-related details like the length of a video or other media.
    • Example values include an array of time durations.
    • Example values:
      • {"file": ["0,0"]}: A duration value for a file.
      • {"file": ["10,0"]}: Another duration value, possibly in minutes and seconds.
filescount
integer
  • An integer indicating the number of files associated with the object.
    • This counts how many files are linked to this object.
    • Example values:
      • 1: There is one file.
      • 3: There are three files.
_METHOD
string
  • A string representing the HTTP method for the request.
    • This field indicates what kind of HTTP operation is being performed (such as GET, PUT, POST, etc.).
    • Example values:
      • "PUT": Used for updating resources.
      • "POST": Used for creating resources.
autorestart
string
  • A string indicating whether the object should automatically restart.
    • This setting controls the auto-restart behavior.
    • Example values:
      • "Yes": The object will automatically restart.
      • "No": The object will not automatically restart.

Responses

Request samples

Content type
application/json
{
  • "parent": 50784,
  • "name": "test",
  • "type": "file",
  • "schedule": "scheduleondatetime",
  • "scheduleondatetime": "2025-01-03 00:01:01",
  • "repeatfor": 1,
  • "loop": "onetime",
  • "files": {
    },
  • "durations": {
    },
  • "filescount": 1,
  • "_METHOD": "PUT",
  • "autorestart": "Yes"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Playlist Updated"
}

Create Playlist clone

Create the playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

playlistid
required
string
Example: <string>

(Required) Playlist ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • A string representing the name of an entity or object.
    • This can be used for identifying or labeling an object or system.
    • Example values:
      • 'flipper': A name given to a particular object.
      • 'turtle': A name used for a different object or system.
start
string
  • A string representing a date and time when something is scheduled to begin.
    • The date is provided in ISO 8601 format and includes the timezone offset.
    • Example values:
      • '2025-01-03T00:00:00+01:00': A specific start date and time in January 2025.
      • '2023-12-25T10:00:00-05:00': A start date and time for Christmas Day in 2023 with a different timezone offset.

Responses

Request samples

Content type
application/json
{
  • "name": "flipper",
  • "start": "2025-01-03T00:00:00+01:00"
}

Response samples

Content type
application/json
{
  • "playlistid": 7942
}

Get Playlist

Get the playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

playlistid
required
integer
Example: 7941

(Required) Playlist ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update Playlist

Update the playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

playlistid
required
integer
Example: 7941

(Required) Playlist ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name of the task or process.
    • This is typically a label or identifier used to describe the task.
    • Example values:
      • 'test': A sample task name.
      • 'backup': The name of a backup process.
type
string
  • A string representing the type of task or operation.
    • It helps define what kind of action or task is being executed.
    • Example values:
      • 'file': Indicates the task involves file-related operations.
      • 'data': Indicates the task involves data processing.
schedule
string
  • A string representing the scheduling method for the task.
    • This determines how and when the task is executed.
    • Example values:
      • 'scheduleondatetime': Indicates that the task will be executed on a specific date and time.
      • 'recurring': Indicates that the task repeats periodically.
scheduleondatetime
string
  • A string representing the exact date and time when the task should be scheduled.
    • This value is used when the task is scheduled for a specific date and time.
    • Example values:
      • '2025-01-03 00:01:01': Indicates a task scheduled for January 3rd, 2025, at 12:01 AM.
      • '2024-12-31 23:59:59': Indicates a task scheduled for December 31st, 2024, at 11:59 PM.
repeatfor
integer
  • An integer representing the number of times the task should be repeated.
    • This determines how many times the task will repeat after the initial execution.
    • Example values:
      • 1: The task will repeat only once.
      • 5: The task will repeat five times.
loop
string
  • A string representing how the task should be looped or repeated.
    • This defines whether the task should repeat continuously or just once.
    • Example values:
      • 'onetime': The task will run only once.
      • 'always': The task will run continuously.
object
file
Array of strings
  • An array representing the list of files associated with the task.
    • This could represent the files to be processed, uploaded, or handled during the task.
    • Example values:
      • ['/1.mp4']: A list containing a single file path for a video.
      • ['/video.mp4', '/image.jpg']: A list containing multiple file paths for different media types.
object
file
Array of strings
  • An array representing the durations associated with the files.
    • This could represent the duration for each file in a task.
    • Example values:
      • ['0,0']: Represents a file with no duration.
      • ['1,30']: Represents a file with a duration of 1 hour and 30 minutes.
filescount
integer
  • An integer representing the number of files involved in the task.
    • This is used to indicate how many files are being processed in the task.
    • Example values:
      • 1: One file is involved in the task.
      • 5: Five files are involved in the task.
autorestart
string
  • A string representing whether the task should automatically restart.
    • This determines if the task should restart after completion or failure.
    • Example values:
      • 'Yes': Indicates that the task will restart automatically.
      • 'No': Indicates that the task will not restart automatically.

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "type": "file",
  • "schedule": "scheduleondatetime",
  • "scheduleondatetime": "2025-01-03 00:01:01",
  • "repeatfor": 1,
  • "loop": "onetime",
  • "files": {
    },
  • "durations": {
    },
  • "filescount": 1,
  • "autorestart": "Yes"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Playlist Updated"
}

Delete playlist

Delete the playlist of Scheduled stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

playlistid
required
integer
Example: 7941

(Required) Playlist ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Playlist Updated"
}

Add platform

Add the platform of a Scheduled stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
Array of objects
  • A list of platforms, where each platform represents a streaming service or configuration.
    • Each platform contains details related to streaming settings and credentials.
    • Example values:
      • One platform could be a custom RTMP service configuration with relevant details such as URL, username, password, etc.
Array
name
string
  • The name of the platform.
    • This is typically a descriptive label for the platform or service.
    • Example values:
      • 'Custom RTMP tipper'
      • 'YouTube Live Streaming'
rtmp
string
  • The RTMP stream URL for the platform.
    • This URL is used to stream live content to the platform.
    • Example values:
      • 'rtmp://live.example.com/app/stream12345'
      • 'rtmp://live.youtube.com/app/stream67890'
key
string
  • The streaming key for the platform.
    • This key is used to authenticate the stream on the platform.
    • Example values:
      • 'password'
      • 'streamingKey12345'
auth
string
  • Indicates whether authentication is required for the platform.
    • 'Y' stands for Yes, meaning authentication is required.
    • 'N' would indicate No, meaning authentication is not required.
    • Example values:
      • 'Y': Authentication is required.
      • 'N': Authentication is not required.
username
string
  • The username used for authentication.
    • This is typically the account name or ID for the platform.
    • Example values:
      • 'admin'
      • 'streamer1'
password
string
  • The password associated with the username.
    • This is used along with the username for authentication on the platform.
    • Example values:
      • 'password'
      • 'securePassword123'
ltc
integer
  • A numeric value that may represent the time in seconds or some specific setting related to the platform.
    • Example values:
      • 1: Represents true or enabled.
      • 0: Represents false or disabled.
vprofiles
integer
  • A numeric value representing the ID or configuration of video profiles.
    • This setting refers to the profiles related to the streaming content or settings for video quality.
    • Example values:
      • 106257: A specific video profile ID.
      • 200450: Another profile ID.
aprofiles
integer
  • A numeric value representing the ID or configuration of audio profiles.
    • This setting refers to the profiles related to the streaming content or settings for audio quality.
    • Example values:
      • 106257: A specific audio profile ID.
      • 203547: Another profile ID.
filters
Array of integers
  • A list of filter IDs that can be applied to the stream.
    • Filters could represent effects, transformations, or processing options for the stream.
    • Example values:
      • [3, 4]: Represents two filter IDs that could apply different effects to the stream.
      • [1, 2, 5]: Represents three different filters.
schedule
string
  • The schedule type for the platform stream.
    • Indicates when the stream should be initiated or triggered.
    • Example values:
      • 'instant': Starts immediately when triggered.
      • 'delayed': Starts after a specified delay.
scheduleontime
string
  • A specific time when the stream should start, if the schedule is not 'instant'.
    • This field is left blank if the stream starts instantly or does not require a scheduled time.
    • Example values:
      • '2025-01-03 12:00:00': A specific time in the future.
      • '': Empty string if no time is set.
scheduleondatetime
string
  • A specific date and time when the stream should start, if the schedule requires it.
    • This field is left blank if the stream starts instantly or does not require a scheduled date.
    • Example values:
      • '2025-01-03 00:01:01': A specific datetime in the future.
      • '': Empty string if no datetime is set.
length
integer
  • The length of the stream in minutes.
    • This determines how long the platform will stream content for once started.
    • Example values:
      • 40: The stream lasts 40 minutes.
      • 60: The stream lasts 1 hour.

Responses

Request samples

Content type
application/json
{
  • "platform": [
    ]
}

Response samples

Content type
application/json
{}

Restart platform

Restart the platform of a Scheduled stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

platformid
required
integer
Example: 42121

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Restarted"
}

Update platform status

Status the platform of a Scheduled stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

platformid
required
integer
Example: 42121

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates the disabled status of an entity or service.
    • This property is typically used to track whether something is disabled (inactive) or enabled (active).
    • Example values:
      • '0': Indicates the entity or service is enabled.
      • '1': Indicates the entity or service is disabled.

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform enabled"
}

Update platform

Update the platform of a Scheduled stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

platformid
required
integer
Example: 42121

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object
name
string
  • The name of the platform.
    • This represents the name or title used to identify the platform.
    • Example values:
      • 'Custom RTMP tipper': The name of the platform in this context.
      • 'Live Streamer Pro': Another possible platform name.
rtmp
string
  • The RTMP (Real-Time Messaging Protocol) URL for streaming.
    • This URL is used to stream content to a specific server or service.
    • Example values:
      • 'rtmp://live.example.com/app/stream12345': A sample RTMP URL for streaming.
      • 'rtmp://streamingplatform.com/live/stream6789': Another example URL.
key
string
  • The key required for authentication or connection to the RTMP server.
    • This key is used to authorize access to the streaming server.
    • Example values:
      • 'password': A sample connection key.
      • 'secretkey123': Another possible connection key.
auth
string
  • A flag indicating whether authentication is required.
    • Typically used to indicate if authentication is needed for accessing the RTMP server.
    • Example values:
      • 'Y': Yes, authentication is required.
      • 'N': No, authentication is not required.
username
string
  • The username required for authentication.
    • This is used alongside the password or key for logging in.
    • Example values:
      • 'admin': A sample username.
      • 'streamer': Another possible username.
password
string
  • The password associated with the username for authentication.
    • This password is used to secure the login to the RTMP server.
    • Example values:
      • 'password': A sample password.
      • 'secure123': Another possible password.
ltc
integer
  • The LTC (Live Time Count) value.
    • Represents the amount of time in minutes for live streaming or other related services.
    • Example values:
      • 1: A live session of 1 minute.
      • 60: A live session of 1 hour.
vprofiles
integer
  • The ID or number associated with video profiles.
    • This ID is used to define or select specific video profile settings.
    • Example values:
      • 106257: A sample video profile ID.
      • 205478: Another possible video profile ID.
aprofiles
integer
  • The ID or number associated with audio profiles.
    • This ID defines or selects specific audio profile settings.
    • Example values:
      • 106257: A sample audio profile ID.
      • 309876: Another possible audio profile ID.
filters
Array of integers
  • A list of filters to be applied to the stream.
    • Each item represents a filter ID or number that modifies the stream's behavior.
    • Example values:
      • [3, 4]: A set of filters applied.
      • [1, 2, 5]: Another set of filters.
schedule
string
  • The schedule for the platform's operation.
    • Specifies when the platform should be active or when specific actions should occur.
    • Example values:
      • 'instant': The operation occurs immediately.
      • 'delayed': The operation occurs after a certain delay.
scheduleontime
string
  • The time when the scheduled action should start.
    • This field can be left empty if no specific time is set for the action.
    • Example values:
      • '': Empty string if no time is specified.
      • '2025-01-01 10:00': A scheduled start time.
scheduleondatetime
string
  • The exact date and time for the scheduled action.
    • This field can be used to set a precise moment when an action should occur.
    • Example values:
      • '': Empty string if no specific date and time is set.
      • '2025-01-01 10:00': A specific scheduled date and time.
length
integer
  • The length of time (in minutes) for which the platform will operate.
    • Specifies how long the operation will last.
    • Example values:
      • 40: A duration of 40 minutes.
      • 120: A duration of 2 hours.

Responses

Request samples

Content type
application/json
{
  • "platform": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [
    ],
  • "errors": [
    ]
}

Delete Platform

Delete the Platform of Scheduled stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

platformid
required
integer
Example: 42121

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "platform": {
    }
}

Stream

Return details of the stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Update Info

Update information of scheduled playlist

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
draft
string
  • Indicates the draft status of the content.
    • Represents whether the content is in draft mode or ready for publishing.
    • Example values:
      • '0': Content is not in draft, meaning it is either published or ready to be used.
      • '1': Content is in draft mode, not yet finalized for public use.
platformtype
string
  • Specifies the type of platform the content is associated with.
    • Used to categorize or identify the platform for the content.
    • Example values:
      • 'Web': The content is associated with a web-based platform.
      • 'Mobile': The content is meant for mobile platforms.
      • 'TV': The content is associated with television platforms.
protocols
Array of strings
  • A list of protocols supported by the platform.
    • These protocols define how content is delivered or streamed across different platforms.
    • Example values:
      • ['RTMP', 'RTSP']: Indicates support for Real-Time Messaging Protocol and Real-Time Streaming Protocol.
      • ['DASH']: Indicates support for Dynamic Adaptive Streaming over HTTP.
preroll
string
  • Indicates whether a preroll advertisement is enabled or not.
    • A preroll is an advertisement that plays before the main content starts.
    • Example values:
      • 'Y': Preroll advertisement is enabled.
      • 'N': Preroll advertisement is disabled.

Responses

Request samples

Content type
application/json
{
  • "draft": "0",
  • "platformtype": "",
  • "protocols": [
    ],
  • "preroll": "Y"
}

Response samples

Content type
application/json
{}

Delete Info

Delete information of scheduled playlist.To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51748

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Multistream

Create Multistream

Create new Restream

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • Represents the name or identifier of the resource.
    • Typically used to describe or label the resource for easier identification.
    • Example values could include project names, stream names, or other identifiers such as 'project/stream1' or 'myStream/setup'.
server
number
  • Specifies the server ID where the resource is hosted or connected.
    • Used to link the resource to a specific server instance.
    • Example values could be '101' for a test server or '209' for a production server.
type
string
  • Indicates the type of operation or configuration.
    • Commonly specifies the purpose of the setup, such as 'push' for pushing data streams.
    • Example values include 'push' or 'pull'.
url
Array of arrays
  • An array of URLs associated with the resource.
    • Used to define endpoints or resources to interact with.
    • Example values could include ['http://example.com/stream'] or an empty array [].
codec
string
  • Specifies the codec used for encoding or decoding media streams.
    • Determines how the video or audio is compressed.
    • Example values include 'h264' for video compression or 'aac' for audio.
vprofiles
Array of arrays
  • An array of IDs representing video profiles.
    • Used to define specific video encoding settings.
    • Example values could include [14931, 14937] for low and high-quality profiles.
aprofiles
Array of arrays
  • An array of IDs representing audio profiles.
    • Used to define specific audio encoding settings.
    • Example values include [14931] for default audio profiles.
filters
Array of arrays
  • An array of filter IDs applied to the media stream.
    • Used for enhancing or modifying the stream quality.
    • Example values include [3, 4] for noise reduction or sharpening filters.
_METHOD
string
  • Specifies the HTTP method used for the operation.
    • Indicates the type of action being performed, such as 'GET', 'POST', 'PUT', or 'DELETE'.
    • Example values include 'PUT' for updates.
Array of objects
  • An array of platform configurations where the stream is hosted or delivered.
    • Each platform object contains detailed settings like credentials and schedules.
    • Example includes RTMP platforms or CDN configurations.
Array
name
string
  • The name of the platform or service. - Identifies the streaming service or endpoint. - Example values include 'Custom RTMP tipper' or 'YouTube'.
rtmp
string
  • The RTMP URL used for streaming. - Defines the endpoint where the stream is pushed. - Example values include 'rtmp://live.example.com/app/stream12345'.
key
string
  • The stream key for authentication and authorization. - Used to uniquely identify and secure the stream. - Example values include 'password' or 'stream123'.
auth
string
  • Indicates whether authentication is enabled ('Y' or 'N'). - Ensures only authorized users can access the stream. - Example values include 'Y' for enabled or 'N' for disabled.
username
string
  • The username for platform login. - Used for authentication during streaming setup. - Example values include 'admin' or 'user123'.
password
string
  • The password for platform login. - Used alongside the username for secure access. - Example values include 'password123' or 'securepass'.
ltc
number
  • Indicates the timecode format or frame count. - Typically used for synchronization purposes. - Example values include 1 for linear timecode or 0 for no timecode.
vprofiles
number
  • Specifies the video profile ID. - Represents the encoding settings for the video stream. - Example values include 106257 for high definition profiles.
aprofiles
number
  • Specifies the audio profile ID. - Represents the encoding settings for the audio stream. - Example values include 106257 for high-quality audio profiles.
filters
Array of arrays
  • An array of filter IDs applied to the stream. - Used for enhancing or modifying the quality of the stream. - Example values include [3, 4] for specific filters.
schedule
string
  • Specifies the scheduling type. - Indicates whether the stream is instant or scheduled. - Example values include 'instant' or 'scheduled'.
scheduleontime
string
  • The specific time for scheduled streams. - Empty for instant streams. - Example values include '12:00:00' or ''.
scheduleondatetime
string
  • The specific date and time for scheduled streams. - Empty for instant streams. - Example values include '2025-01-01T12:00:00' or ''.
length
number
  • The duration of the stream in seconds. - Represents the total runtime of the stream. - Example values include 40 for 40 seconds or 3600 for 1 hour.

Responses

Request samples

Content type
application/json
{
  • "name": "jippwe/sdaty",
  • "server": 209,
  • "type": "push",
  • "url": [ ],
  • "codec": "h264",
  • "vprofiles": [
    ],
  • "aprofiles": [
    ],
  • "filters": [
    ],
  • "_METHOD": "PUT",
  • "platform": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Created",
  • "stream": {
    }
}

Stream

Return the details of restream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stream": {
    }
}

Update Info

Update information of Restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
draft
string
  • Indicates whether the configuration is in draft mode.
    • Commonly used for staging or testing purposes before making changes live.
    • Examples: '0' (not a draft), '1' (draft mode).
platformtype
string
  • Specifies the type of platform for the operation.
    • Typically used to identify the platform category or system type.
    • Examples: 'YouTube', 'Facebook'.
server
string
  • Represents the server ID or identifier for the operation.
    • Provides context about which server is being targeted or used.
    • Examples: '209' (a server ID), '305'.
type
string
  • Specifies the type of operation or service being used.
    • Provides clarity about the nature of the stream or action.
    • Examples: 'restream', 'livestream'.
mode
string
  • Defines the streaming mode for the operation.
    • Provides clarity about the type of streaming being performed.
    • Examples: 'hls' (HTTP Live Streaming), 'dash' (Dynamic Adaptive Streaming over HTTP).
url
Array of strings
codec
string
  • Specifies the video codec being used for encoding the stream.
    • Commonly used to optimize performance and compatibility.
    • Examples: 'h264' (Advanced Video Codec), 'vp9'.
audiofix
string
  • Indicates whether an audio fix is applied to the stream.
    • Typically used to resolve audio issues or improve audio quality.
    • Examples: 'Y' (yes, fix applied), 'N' (no fix applied).

Responses

Request samples

Content type
application/json
{
  • "draft": "0",
  • "platformtype": "",
  • "server": "209",
  • "type": "restream",
  • "mode": "hls",
  • "url": [],
  • "codec": "h264",
  • "audiofix": "Y"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Delete Info

Delete information of a restream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
string
Example: <string>

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Multistream deleted successfully."
}

Streams

Restream list

Authorizations:
apikeyAuth
query Parameters
page
integer
Example: page=1
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "streams": [
    ]
}

statistics

Return the details of restream statistics

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "0": {
    },
  • "transcode": {
    }
}

Update status of stream

Update status of stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
integer
  • Indicates whether a specific feature or functionality is disabled.
    • A value of '0' typically means 'not disabled' (enabled), while other values may indicate a disabled state.

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "streams": [
    ]
}

Update RTMP Auth

Update RTMP auth of Restream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51769

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether a specific feature or functionality is enabled.
    • A value of 'Y' typically represents 'enabled,' while other values such as 'N' might indicate 'disabled.
username
string
  • Represents the username for authentication purposes.
    • Typically used in login credentials or API connections.
    • Example usernames might include 'admin' or 'user123.'
password
string
  • Represents the password for authentication purposes.
    • Used to securely access systems, applications, or APIs.
    • Example values could include 'password123' or 'secureP@ss.'

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "username": "admin",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Restore Stream

Restore publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51769

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restored",
  • "stream": {
    }
}

Restart Stream

Restart publish stream.

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51768

(Required) Stream ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Restarted"
}

Update transcode

Update the transcode of a publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
ltc
string
  • Represents the lifetime count or a similar numerical identifier.
    • Used for tracking or identifying a specific metric or category.
    • Examples include '2' for a count or reference ID, or '10' for a higher count.
vprofiles
Array of strings
  • Contains a list of profile identifiers, typically related to video or visual profiles.
    • Each value in the array is a string representing a unique profile ID.
    • Example values include '106257' for one profile and '106256' for another profile.
aprofiles
Array of strings
  • Contains a list of profile identifiers, typically related to audio or another type of profile.
    • Each value in the array is a string representing a unique profile ID.
    • Example values include '0' for a default profile or '12345' for a custom profile.
filters
Array of strings
  • Contains a list of filter identifiers, typically used to define settings or constraints.
    • Each value in the array is a string representing a unique filter ID.
    • Examples include '3' for a specific filter and '4' for another option.

Responses

Request samples

Content type
application/json
{
  • "ltc": "2",
  • "vprofiles": [
    ],
  • "aprofiles": [
    ],
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Updated",
  • "stream": {
    }
}

Add platform

Add the platform of a publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
type
any
object
  • Represents the configuration for a platform, including its RTMP settings, authentication details, and scheduling options.
    • Contains properties defining the platform's name, stream URL, credentials, profiles, and scheduling preferences.
    • Examples include a custom RTMP streaming platform with specific authentication and scheduling settings.
name
string
  • The name of the platform. - Represents the platform or service being used for streaming. - Examples include 'Custom RTMP tipper' for a custom setup or 'YouTube Live' for a YouTube streaming platform.
rtmp
string
  • The RTMP URL for the platform. - Used as the endpoint for streaming video to the platform. - Examples include 'rtmp://live.example.com/app/stream12345' for a custom server or 'rtmp://a.rtmp.youtube.com/live2/xyz123' for YouTube.
key
string
  • The stream key for the RTMP platform. - Used to authenticate and identify the stream being sent to the platform. - Examples include 'password' for a simple key or 'abc123xyz' for a more complex key.
auth
string
  • Indicates whether authentication is required for the platform. - 'Y' for yes (authentication required) and 'N' for no (authentication not required). - Examples include 'Y' for a secured platform or 'N' for an open platform.
username
string
  • The username for authentication on the platform. - Used in combination with the password to access the platform. - Examples include 'admin' for a default username or 'streamer123' for a custom user.
password
string
  • The password for authentication on the platform. - Used in combination with the username to access the platform securely. - Examples include 'password' for a default password or 'securePass123' for a stronger password.
vprofiles
integer
  • The video profile identifier for the platform. - Represents a predefined or custom video profile used for streaming. - Examples include '0' for a default profile or '1' for a high-quality profile.
aprofiles
integer
  • The audio profile identifier for the platform. - Represents a predefined or custom audio profile used for streaming. - Examples include '0' for a default profile or '2' for a high-bitrate profile.
schedule
string
  • The scheduling option for the stream. - Represents when the stream is set to start, such as 'instant' for immediate streaming or 'scheduled' for a future time. - Examples include 'instant' for immediate start and 'scheduled' for a delayed start.
scheduleontime
null
  • The specific time for the stream to start. - Used for scheduling streams at a particular time of day. - Example values include null when scheduling is not time-based.
scheduleondatetime
null
  • The specific date and time for the stream to start. - Used for scheduling streams at a precise date and time. - Example values include null when scheduling is not date-based.

Responses

Request samples

Content type
application/json
{
  • "type": null,
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Created",
  • "stream": {
    }
}

Restart platform

Restart the platform of a publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

platformid
required
integer
Example: 42124

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Restarted"
}

Update platform status

Status the platform of a publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

platformid
required
integer
Example: 42124

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
disabled
string
  • Indicates whether a particular feature, platform, or functionality is disabled.
    • The value '0' typically means it is enabled, while '1' means it is disabled.
    • Examples include '0' to show the platform is active and functioning, or '1' to indicate it has been turned off or deactivated.

Responses

Request samples

Content type
application/json
{
  • "disabled": "0"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform enabled"
}

Update platform

Update the platform of a publish stream

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

platformid
required
integer
Example: 42126

(Required) Platform ID

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
object
  • Contains information about the platform configuration for a custom RTMP tipper.
    • Includes details like platform name, RTMP URL, authentication credentials, profiles, and scheduling options.
    • Examples: Configuration for a live-streaming platform or a video broadcasting service.
name
string
  • The name of the platform. - Represents the identifier or label for the custom RTMP platform. - Examples: 'Custom RTMP tipper', 'YouTube Live'.
rtmp
string
  • The RTMP URL used to stream video to the platform. - Represents the endpoint for live-streaming services. - Examples: 'rtmp://live.example.com/app/stream12345', 'rtmp://stream.platform.com/app'.
key
string
  • The stream key or password used to authenticate the RTMP stream. - Necessary for connecting and verifying the source with the platform. - Examples: 'password', 'stream123'.
auth
string
  • Indicates if authentication is required for the platform. - Common values: 'Y' for yes, 'N' for no. - Examples: 'Y', 'N'.
username
string
  • The username used for authentication. - Necessary when the platform requires login credentials. - Examples: 'admin', 'streamer_user'.
password
string
  • The password used for authentication. - Necessary to verify access credentials. - Examples: 'password', 'securekey123'.
vprofiles
number
  • Represents the number of video profiles configured for the platform. - Used to control video quality or resolution options. - Examples: 0 (default profile), 2 (two profiles configured).
aprofiles
number
  • Represents the number of audio profiles configured for the platform. - Used to control audio quality or configuration options. - Examples: 0 (default profile), 1 (one profile configured).
schedule
string
  • Specifies the scheduling option for the platform. - Determines whether the streaming starts instantly or at a specific time. - Examples: 'instant' for immediate streaming, 'scheduled' for timed streaming.
scheduleontime
null
  • Represents the specific time for the scheduled stream. - Null if no specific time is set or if the schedule is 'instant'. - Examples: null, '14:00' (2 PM in 24-hour format).
scheduleondatetime
null
  • Represents the specific date and time for the scheduled stream. - Null if no specific date and time are set or if the schedule is 'instant'. - Examples: null, '2024-01-16T14:00:00Z' (ISO format).

Responses

Request samples

Content type
application/json
{
  • "platform": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Delete Platform

Delete the Platform of publish stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
streamid
required
integer
Example: 51778

(Required) Stream ID

platformid
required
integer
Example: 42126

(Required) Platform ID

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Platform Updated",
  • "warnings": [ ],
  • "errors": [ ]
}

Standard Reports

Reports for Standard Network

Stats

Summary report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
range
string
  • Specifies a date and time range. - Represents the starting point for a specific time range in ISO 8601 format. - Example values: '2025-01-15 00:00:00', '2025-01-01 12:00:00'.
type
string
  • Defines the granularity or interval of the data. - Commonly used to indicate the aggregation level of data such as 'hourly', 'daily', or 'monthly'. - Example values: 'hourly', 'daily'.

Responses

Request samples

Content type
application/json
{
  • "range": "2025-01-15 00:00:00",
  • "type": "hourly"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Cache

Cache Statistics report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Specifies the frequency of data or events. - Used to indicate intervals or repetitions. - Example values: '2' (indicating every 2 units of time), '1' (indicating once per unit of time).
filter_type
string
  • Indicates the type of filter applied. - Represents the method or criteria for data filtering. - Example values: '0' (no filter), '1' (specific filtering criteria).
start_date
string
  • The starting date for the data range. - Represented in ISO 8601 format. - Example values: '2024-12-27', '2024-01-01'.
end_date
string
  • The ending date for the data range. - Represented in ISO 8601 format. - Example values: '2025-01-03', '2024-12-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "filter_type": "0",
  • "start_date": "2024-12-27",
  • "end_date": "2025-01-03"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Top Files

Top Files report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
string
  • The start date for the specified time period. - Typically used to mark the beginning of an operation or data range. - Example values: '2024-12-30', '2025-01-01'.
end_date
string
  • The end date for the specified time period. - Indicates the conclusion of an operation or data range. - Example values: '2025-01-06', '2025-01-15'.
type
string
  • The type or category for the data or operation. - Defines the nature of the process or range being referred to. - Example values: 'dynamic', 'static'.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06",
  • "type": "dynamic"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Top Referrers

Top Referrers report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
start_date
string
  • Represents the start date of a specific time period or event.
    • The date should be formatted as 'YYYY-MM-DD' (ISO 8601 standard).
    • Examples include '2024-12-30' for the 30th of December, 2024, or '2025-01-01' for the 1st of January, 2025.
end_date
string
  • Represents the end date of a specific time period or event.
    • The date should be formatted as 'YYYY-MM-DD' (ISO 8601 standard).
    • Examples include '2025-01-06' for the 6th of January, 2025, or '2025-01-31' for the 31st of January, 2025.

Responses

Request samples

Content type
application/json
{
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06"
}

Response samples

Content type
application/json
{}

Status Codes

Status Codes report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Specifies how often an event or operation occurs.
    • Typically represented as a numeric or descriptive value indicating recurrence.
    • Examples include '2' for twice a day or '7' for weekly operations.
start_date
string
  • The starting date of a specified period or event.
    • Should be formatted as 'YYYY-MM-DD' (ISO 8601 standard).
    • Examples include '2024-12-30' for December 30, 2024, or '2025-01-01' for January 1, 2025.
end_date
string
  • The ending date of a specified period or event.
    • Should be formatted as 'YYYY-MM-DD' (ISO 8601 standard).
    • Examples include '2025-01-06' for January 6, 2025, or '2025-01-15' for a mid-January date.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Countries

By Country report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents how often an event or action occurs.
    • Typically provided as a numerical string indicating the frequency.
    • Examples include '2' (every 2 days) or '7' (weekly).
start_date
string
  • The date when the event or action begins.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2024-12-30' or '2025-01-01'.
end_date
string
  • The date when the event or action ends.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2025-01-06' or '2025-01-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Browser

By Browser report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents how often an event or action occurs.
    • Typically provided as a numerical string indicating the frequency.
    • Examples include '2' (every 2 days) or '7' (weekly).
start_date
string
  • The date when the event or action begins.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2024-12-30' or '2025-01-01'.
end_date
string
  • The date when the event or action ends.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2025-01-06' or '2025-01-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

OS

By OS report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents how often an event or action occurs.
    • Typically provided as a numerical string indicating the frequency.
    • Examples include '2' (every 2 days) or '7' (weekly).
start_date
string
  • The date when the event or action begins.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2024-12-30' or '2025-01-01'.
end_date
string
  • The date when the event or action ends.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2025-01-06' or '2025-01-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Visitors

Visitors report.

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
frequency
string
  • Represents how often an event or action occurs.
    • Typically provided as a numerical string indicating the frequency.
    • Examples include '2' (every 2 days) or '7' (weekly).
start_date
string
  • The date when the event or action begins.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2024-12-30' or '2025-01-01'.
end_date
string
  • The date when the event or action ends.
    • Provided in ISO 8601 format ('YYYY-MM-DD').
    • Examples include '2025-01-06' or '2025-01-31'.

Responses

Request samples

Content type
application/json
{
  • "frequency": "2",
  • "start_date": "2024-12-30",
  • "end_date": "2025-01-06"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Volume/Premium Reports

Reports for Volume/Premium Network

Statistics

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=last_30days/daily

Month/Granularity, Granularity can be daily/hourly

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Cache

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2024-10-15%2000:00:00/hourly

granularity/0/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    },
  • "edgegroups": {
    }
}

Top Files

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2024-10-15%2000:00:00/hourly

from/to/type, type -> dynamic

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

Status Codes

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2/2024-12-30/2025-01-06

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

By Country

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2024-10-15%2000:00:00/hourly

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

By Browsers

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2024-10-15%2000:00:00/hourly

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

By OS

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2/2024-10-30/2025-01-06

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

By Device

Authorizations:
apikeyAuth
query Parameters
r
string
Example: r=2/2024-10-30/2025-01-06

granularity/from/to Granularity: 0 (Minute), 1 (Hour), 2 (Day)

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "stats": {
    }
}

CDN Logs

Authorizations:
apikeyAuth
query Parameters
from
string
to
string
limit
integer
Example: limit=10

max: 1000

offset
integer
Example: offset=2
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{ }

Enterprise Reports

Reports for Enterprise Network

By Stream Traffic

Get reports of stream traffic

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
r
string
  • Represents a date range for the query.
    • The format is 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS'.
    • Provides a clear time period for retrieving data, such as daily or monthly statistics.
    • Example values include '2024-10-30 00:00:00 - 2025-01-06 00:00:00' or '2023-01-01 00:00:00 - 2023-12-31 23:59:59'.
t
string
  • Specifies the time interval for the data.
    • Common values include 'daily', 'weekly', 'monthly', or 'yearly', which determine the granularity of the statistics.
    • Example values include 'daily' for day-by-day data or 'monthly' for month-by-month summaries.
m
string
  • Represents the metric type for the data query.
    • Indicates the focus of the statistics, such as 'hits', 'views', or 'clicks'.
    • Example values include 'hits'

Responses

Request samples

Content type
application/json
{
  • "r": "2024-10-30 00:00:00 - 2025-01-06 00:00:00",
  • "t": "daily",
  • "m": "hits"
}

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByTime": null,
  • "bytesByCPC": null,
  • "hitsByTime": null,
  • "hitsByCPC": null,
  • "mhitsByTime": null
}

By Stream Duv

Get reports of stream daily unique visitors

Authorizations:
apikeyAuth
header Parameters
r
string
Example: <string>

(Required) Date range format should be yyyy-mm-dd hh:min:sec - yyyy-mm-dd hh:min:sec ,eg: 2020-10-04 10:29:00 - 2020-10-14 10:29:00

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "duvByTime": null,
  • "duvByCountry": null,
  • "duvByState": null,
  • "duvByProvince": null,
  • "duvByBrowser": null,
  • "duvByOS": null
}

By Stream Top Visitors

Get reports of stream topvisitors

Authorizations:
apikeyAuth
header Parameters
r
string
Example: <string>

(Required) Date range format should be yyyy-mm-dd hh:min:sec - yyyy-mm-dd hh:min:sec ,eg: 2020-10-04 10:29:00 - 2020-10-14 10:29:00

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "bytesByIP": null,
  • "hitsByIP": null
}

By Stream Bo

Get reports of stream bybo

Authorizations:
apikeyAuth
header Parameters
r
string
Example: <string>

(Required) Date range format should be yyyy-mm-dd hh:min:sec - yyyy-mm-dd hh:min:sec ,eg: 2020-10-04 10:29:00 - 2020-10-14 10:29:00

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "hitsByBrowser": null,
  • "hitsByOS": null
}

By Stream Geo

Get reports of stream bygeo

Authorizations:
apikeyAuth
header Parameters
r
string
Example: <string>

(Required) Date range format should be yyyy-mm-dd hh:min:sec - yyyy-mm-dd hh:min:sec ,eg: 2020-10-04 10:29:00 - 2020-10-14 10:29:00

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "trafficByCountry": null
}

By Stream Uv

Get reports of stream uv

Authorizations:
apikeyAuth
header Parameters
t
string
Example: <string>

(Required) Enter daily or hourly

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "uvByTime": null
}

By Stream Url Response

Get reports of stream urlresponse

Authorizations:
apikeyAuth
header Parameters
m
string
Example: <string>

(Required) Enter reported by

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlrByTime": null,
  • "urlrByUrl": null
}

By Stream Url Traffic

Get reports of stream urltraffic

Authorizations:
apikeyAuth
header Parameters
m
string
Example: <string>

(Required) Enter reported by

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": null,
  • "urlBytesByUrl": null,
  • "urlHitsByUrl": null
}

Recording Minutes Reports

Reports for Recording Minutes

Reports by stream reports live mins stats

Get reports of stream live mins stats

Authorizations:
apikeyAuth
header Parameters
r
string
Example: <string>

(Required) Enter value last_24hrs/hourly or last_7days/hourly or last_30days/daily

f
string
Example: <string>

(Required) Enter reported by

Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "files": [
    ],
  • "logs": [
    ],
  • "logsinfo": {
    }
}

Global Settings

Global Stream Settings

Update Stream Domain Setting

update stream domain setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature is enabled.
    • Common values include 'Y' for yes (enabled) or 'N' for no (disabled).
    • Example values: 'Y', 'N'.
policy
string
  • Defines the policy setting for the feature.
    • Common values include 'Y' for an active policy or 'N' for no policy in effect.
    • Example values: 'Y', 'N'.
list
string
ips
string
  • A comma-separated list of IP addresses.
    • Used to define a set of IPs for specific purposes like whitelisting or access control.
    • Example values: '1.1.1.1,2.2.2.2', '192.168.1.1,10.0.0.1'.
noreferer
string
  • Indicates if referrer information should be omitted.
    • Common values include 'Y' for yes (omit referrer) or 'N' for no (include referrer).
    • Example values: 'Y', 'N'.
mode
string
  • Specifies the mode of operation for the feature.
    • Common values include 'push' for pushing data or 'pull' for retrieving data.
    • Example values: 'push', 'pull'.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": "www.google.com,www.example.com",
  • "ips": "1.1.1.1,2.2.2.2",
  • "noreferer": "Y",
  • "mode": "push"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Streams Geo block Setting

update streams geoblock setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or not.
    • This is a flag that determines if the feature should be active.
    • It can be either 'Y' for enabled or 'N' for disabled.
policy
string
  • Specifies the policy status associated with the service.
    • This could represent whether the policy is active or inactive.
    • Typically, 'Y' means the policy is active, and 'N' means inactive.
list
Array of strings
  • A list of country codes that are allowed or relevant for the operation.
    • This could be a list of countries where a service or feature is available or permitted.
    • Example values: 'GB' (United Kingdom), 'US' (United States).
ips
string
  • A string representing the IP addresses associated with the service.
    • Multiple IPs can be provided, separated by commas.
    • This could represent trusted IPs or source addresses.
    • Example values: '1.1.1.1,2.2.2.2' representing two different IP addresses.
mode
string
  • Specifies the mode of operation.
    • This can represent the mode in which the service or system operates.
    • Common values could be 'push' for active sending, or 'pull' for fetching data from a source.
    • In this case, 'push' indicates that the system is in a push mode.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "N",
  • "list": [
    ],
  • "ips": "1.1.1.1,2.2.2.2",
  • "mode": "push"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Stream Securetoken Setting

update stream securetoken setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or not.
    • This property is used to toggle the feature on or off.
    • Possible values: 'Y' (enabled) or 'N' (disabled).
policy
string
  • Represents the current policy status.
    • This could indicate whether the current policy is active or inactive.
    • Possible values: 'F' (inactive) or 'A' (active).
list
string
  • A unique identifier or reference for a list.
    • This could be a reference to a specific data list, like a session or a set of users.
    • Example value: '9d0c4b0e30cde228' representing a list ID.
timeout
string
  • The duration (in seconds) for which the service or session will remain active before timing out.
    • Represents the maximum time allowed for the operation or session.
    • Example: '3600' means 1 hour before the timeout occurs.
session
string
  • Represents the current session ID.
    • It is used to track or identify a particular session during its lifecycle.
    • Example: '0' could indicate an inactive or a fresh session.
keyip
string
  • Indicates whether IP key validation is enabled or not.
    • This could be used to enforce restrictions on access based on IP address.
    • Possible values: 'Y' (enabled) or 'N' (disabled).
ips
string
  • A string representing the IP addresses that are authorized or allowed.
    • Multiple IP addresses are separated by commas.
    • Example value: '1.1.1.1,2.2.2.2' representing two authorized IP addresses.
mode
string
  • Specifies the mode of operation.
    • This determines how the system should behave.
    • Possible values could be 'push' (actively sends data) or 'pull' (fetches data).
    • Example: 'push' indicates the system operates in a mode that pushes data to a destination.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "policy": "F",
  • "list": "9d0c4b0e30cde228",
  • "timeout": "3600",
  • "session": "0",
  • "keyip": "Y",
  • "ips": "1.1.1.1,2.2.2.2",
  • "mode": "push"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Stream RtmpAuth Setting

update stream rtmpauth setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or not.
    • This property is used to toggle the feature on or off.
    • Possible values: 'Y' (enabled) or 'N' (disabled).
username
string
  • Represents the username for accessing the system or service.
    • This is used for authentication purposes.
    • Example values: 'admin', 'user1'.
password
string
  • Represents the password associated with the username for authentication.
    • This is used to securely log in to the system or service.
    • Example values: 'password123', 'qwerty@2025'.
mode
string
  • Specifies the mode of operation.
    • This determines how the system should behave.
    • Possible values could be 'push' (actively sends data) or 'pull' (fetches data).
    • Example: 'push' indicates the system operates in a mode that pushes data to a destination.

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "username": "admin",
  • "password": "password",
  • "mode": "push"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Stream ndvr Setting

update stream ndvr setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or disabled.
    • This property is used to toggle the feature on or off.
    • Possible values: 'Y' (enabled) or 'N' (disabled).
retention
string
  • Specifies the retention period, typically in days, for the data or resource.
    • This property determines how long data will be stored before it is deleted or archived.
    • Example values: '30' (30 days), '365' (1 year).
mode
string
  • Defines the mode or action to be performed.
    • This property indicates the method or approach the system should use for data handling.
    • Possible values: 'save' (save data), 'delete' (delete data).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "33",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Stream Record Setting

update stream record setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or disabled.
    • This property is used to toggle the feature on or off.
    • Possible values: 'Y' (enabled) or 'N' (disabled).
retention
string
  • Specifies the retention period, typically in days, for the data or resource.
    • This property determines how long data will be stored before it is deleted or archived.
    • Example values: '30' (30 days), '365' (1 year).
mode
string
  • Defines the mode or action to be performed.
    • This property indicates the method or approach the system should use for data handling.
    • Possible values: 'save' (save data), 'delete' (delete data).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "retention": "33",
  • "mode": "save"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Stream CName Setting

update stream cname setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
cname
string
  • Represents the canonical names (CNAMEs) associated with a domain or service.
    • This property stores one or more CNAMEs separated by a comma.
    • CNAMEs are often used in DNS settings to alias one domain to another.
    • Example values: 'jon.5centscdndemo.ca,k.5centscdndemo.ca' (two CNAMEs), 'example.com' (single CNAME).
certid
string
  • Represents the certificate ID associated with a service or domain.
    • This property is used to link a service with a specific certificate for validation or security purposes.
    • Example values: '5' (a numeric ID), '10' (another numeric ID).

Responses

Request samples

Content type
application/json
{
  • "cname": "jon.5centscdndemo.ca,k.5centscdndemo.ca",
  • "certid": "5"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Update Stream Hash Setting

update stream hash setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
enabled
string
  • Indicates whether the feature or service is enabled or disabled.
    • This is a flag that controls the active state of a feature.
    • The value can be 'Y' for enabled or 'N' for disabled.
    • Example values: 'Y' (enabled), 'N' (disabled).
hashrestream
string
  • Specifies whether hash restreaming is enabled.
    • Hash restreaming might be related to secure streaming or data integrity during streaming.
    • The value can be 'Y' for enabled or 'N' for disabled.
    • Example values: 'Y' (enabled), 'N' (disabled).
extension
string
key
string
  • A unique identifier or key used for authentication, referencing, or access control.
    • This is often used in API calls or system configurations.
    • Example values: 'test' (as an identifier), 'abc123' (another key).

Responses

Request samples

Content type
application/json
{
  • "enabled": "Y",
  • "hashrestream": "Y",
  • "extension": "",
  • "key": "test"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Stream Settings Updated. Please wait till the deployment completes."
}

Live Transcoding Profiles/Filters

Add Stream Profiles Setting

add stream profiles setting

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name of the item or file.
    • Represents the identifier or label for the item.
    • Example values could be names of files, projects, or configurations.
filemode
string
  • The mode of the file.
    • Represents how the file should be processed or handled.
    • Can include values like 'sd' for standard definition or 'hd' for high definition.
f
string
  • The file format type.
    • Specifies the format of the media file, such as mp4 or avi.
    • Common formats include mp4, avi, and mkv.
cv
string
  • The video codec.
    • Specifies the encoding method for video compression.
    • Common codecs include 'libx264' for H.264 encoding, and 'vp9' for Google's video codec.
sv
string
  • The video resolution.
    • Defines the quality and dimensions of the video.
    • Common values are '720p', '1080p', and '4k'.
svvalue
string
  • Optional value for further specification.
    • Can be left empty or used for additional parameters.
    • Example values might include custom resolutions or formats.
deinterlace
integer
  • The deinterlacing option.
    • Indicates whether to apply deinterlacing to the video.
    • Values could be 0 for no deinterlacing, 1 for deinterlacing applied.
crf
string
  • The constant rate factor.
    • Defines the quality of the output video. Lower values provide higher quality.
    • Example values are 'll' for low-latency or numerical values like '23' for a specific quality.
bv
integer
  • The video bitrate flag.
    • Represents whether video bitrate is used for encoding.
    • Values are typically 1 (enabled) or 0 (disabled).
bvvalue
integer
  • The bitrate value for video.
    • Defines the amount of data used for video encoding.
    • Example values could be 1000, 2000, or 5000 representing bitrate in kilobits per second.
vpass
integer
  • The video pass option.
    • Specifies the number of encoding passes.
    • Can be set to 1 for single-pass encoding or 2 for two-pass encoding.
fps
integer
  • The frames per second.
    • Indicates the frame rate at which the video plays.
    • Common values include 24, 30, and 60 fps.
gop
integer
  • The group of pictures size.
    • Defines the interval between keyframes in video encoding.
    • Typical values range from 15 to 60, depending on the encoding settings.
bframe
integer
  • The number of B-frames to use.
    • B-frames help improve video compression by storing data between keyframes.
    • Values typically range from 0 to 3 for different compression levels.
vprofile
string
  • The video profile.
    • Specifies the profile to use during video encoding.
    • Common options include 'disabled' for no profile or 'baseline' for lower quality encoding.
ca
string
  • The audio codec.
    • Defines the codec to use for audio encoding.
    • Common values include 'aac' for AAC encoding or 'mp3' for MP3 encoding.
aca
integer
  • The number of audio channels.
    • Defines how many audio channels to encode (e.g., mono or stereo).
    • Common values include 1 for mono or 2 for stereo.
ba
integer
  • The audio bitrate flag.
    • Indicates whether audio bitrate is used for encoding.
    • Typically values are 1 (enabled) or 0 (disabled).
bavalue
integer
  • The audio bitrate value.
    • Defines the amount of data used for audio encoding.
    • Example values include 128, 192, or 256 representing audio bitrate in kilobits per second.
ara
integer
  • The audio sample rate.
    • Defines the frequency at which audio samples are recorded.
    • Common values include 22050, 44100, or 48000 Hz.
_METHOD
string
  • The HTTP method used.
    • Specifies the HTTP method for the request (e.g., PUT, GET, POST).
    • Common methods include 'GET' for data retrieval, 'POST' for data submission, and 'PUT' for data updates.

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "filemode": "sd",
  • "f": "mp4",
  • "cv": "libx264",
  • "sv": "720p",
  • "svvalue": "",
  • "deinterlace": 0,
  • "crf": "ll",
  • "bv": 1,
  • "bvvalue": 2000,
  • "vpass": 1,
  • "fps": 30,
  • "gop": 6,
  • "bframe": 1,
  • "vprofile": "disabled",
  • "ca": "aac",
  • "aca": 2,
  • "ba": 1,
  • "bavalue": 80,
  • "ara": 44100,
  • "_METHOD": "PUT"
}

Response samples

Content type
application/json
{
  • "result": null,
  • "message": null,
  • "profileid": null
}

List Live Transcoding Profiles

List Live Transcoding Profiles

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "lists": {
    }
}

Update Stream Profiles Setting

update stream profiles setting

Authorizations:
apikeyAuth
path Parameters
profileid
required
integer
Example: 110375

(Required) Id of the Transcode Profile

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • The name or identifier for the configuration.
    • Represents a user-friendly label for the settings.
    • Example values include 'test' or 'default'.
f
string
  • The format of the output file.
    • Commonly represents the file container type.
    • Example values include 'mp4' or 'mkv'.
cv
string
  • The codec to be used for video compression.
    • Determines the method for encoding video data.
    • Example values include 'libx264' or 'libx265'.
sv
string
  • The desired resolution for the video.
    • Represents the output video resolution setting.
    • Example values include '720p' or '1080p'.
svvalue
string
  • An additional value associated with the resolution setting.
    • Typically left blank if no extra value is needed.
    • Example values include '' (empty) or 'extra_info'.
deinterlace
integer
  • Indicates whether deinterlacing is applied to the video.
    • A value of '0' means no deinterlacing; '1' enables deinterlacing.
    • Example values include 0 or 1.
crf
string
  • The constant rate factor for video quality control.
    • Represents the balance between file size and quality.
    • Example values include 'll' or '23'.
bv
integer
  • Indicates whether a specific bitrate value is used.
    • A value of '1' means a bitrate is applied.
    • Example values include 1 or 0.
bvvalue
integer
  • The bitrate value in kilobits per second (kbps).
    • Determines the video stream's bitrate.
    • Example values include 2000 or 4000.
vpass
integer
  • Specifies the number of encoding passes for video.
    • A higher number may improve quality at the cost of time.
    • Example values include 1 or 2.
fps
integer
  • Frames per second for the video output.
    • Controls the playback smoothness of the video.
    • Example values include 30 or 60.
gop
integer
  • Group of Pictures (GOP) size in frames.
    • Determines the distance between keyframes in the video.
    • Example values include 6 or 12.
preset
string
  • The encoding speed/quality preset for video compression.
    • Faster presets yield quicker encoding with lower quality.
    • Example values include 'superfast' or 'veryfast'.
bframe
integer
  • The number of B-frames between reference frames.
    • Affects compression efficiency and playback quality.
    • Example values include 1 or 2.
vprofile
string
  • The video profile used for encoding.
    • Determines the complexity of the video stream.
    • Example values include 'disabled' or 'high'.
ca
string
  • The codec to be used for audio compression.
    • Specifies the method for encoding audio data.
    • Example values include 'aac' or 'mp3'.
aca
integer
  • The number of audio channels in the output.
    • Common values include mono (1) and stereo (2).
    • Example values include 2 or 1.
ba
integer
  • Indicates whether a specific audio bitrate is used.
    • A value of '1' means an audio bitrate is applied.
    • Example values include 1 or 0.
bavalue
integer
  • The audio bitrate value in kilobits per second (kbps).
    • Determines the audio stream's quality.
    • Example values include 80 or 128.
ara
integer
  • The audio sample rate in hertz (Hz).
    • Determines the audio's frequency resolution.
    • Example values include 44100 or 48000.
now
integer
  • Indicates the current state or flag for the process.
    • Typically used as a status indicator.
    • Example values include 0 or 1.

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "f": "mp4",
  • "cv": "libx264",
  • "sv": "720p",
  • "svvalue": "",
  • "deinterlace": 0,
  • "crf": "ll",
  • "bv": 1,
  • "bvvalue": 2000,
  • "vpass": 1,
  • "fps": 30,
  • "gop": 6,
  • "preset": "superfast",
  • "bframe": 1,
  • "vprofile": "disabled",
  • "ca": "aac",
  • "aca": 2,
  • "ba": 1,
  • "bavalue": 80,
  • "ara": 44100,
  • "now": 0
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

Delete Profile Info

Delete the profile of stream. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
profileid
required
string
Example: <string>

(Required) Id of the Transcode Profile

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

List File Transcoding Filters

List File Transcoding Filters

Authorizations:
apikeyAuth
header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{}

Create File Transcoding Filters

Create File Transcoding Filters

Authorizations:
apikeyAuth
header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • Represents the name associated with the operation.
    • Useful for identifying specific tasks or filters applied.
    • Examples include 'flopTest', 'rotateVideo', or 'addLogo'.
filter
string
  • Specifies the type of filter being applied.
    • Provides details about the operation to be performed, such as overlaying text or images.
    • Examples include 'drawtext', 'overlay', or 'crop'.
object
object
url
string
  • URL of the overlay resource (e.g., an image) to be applied to the video. - Empty string indicates no overlay applied. - Examples include 'https://example.com/logo.png' or ''.
scale
string
  • Scale factor for resizing the overlay. - Determines how large the overlay appears on the video. - Examples include '100' (full size) or ''.
position
string
  • Defines the position of the overlay on the video. - Common values include 'Top Left', 'Center', or 'Bottom Right'. - Examples include 'Top Left' or ''.
object
text
string
  • The text content to be displayed on the video. - Can be used for captions, labels, or watermarks. - Examples include 'Testing' or 'Hello World'.
fontsize
integer
  • Size of the font for the text. - Determines how large the displayed text appears. - Examples include 16, 24, or 32.
fontcolor
string
  • Color of the text in hexadecimal format. - Used for styling the text appearance. - Examples include '#42a5f5' (blue) or '#ff0000' (red).
position
string
  • Position of the text on the video. - Can specify alignment such as 'Center', 'Top Left', or 'Bottom Right'. - Examples include 'Center' or 'Top Left'.
object
url
string
  • URL of the image to be converted into a video format. - If empty, no image-to-video operation is performed. - Examples include 'https://example.com/image.png' or ''.
object
url
string
  • URL of the video to be looped. - Used to specify a source video for repeating playback. - Examples include 'https://example.com/video.mp4' or ''.
_METHOD
string
  • Specifies the HTTP method to be used for the operation.
    • Commonly used for updating resources.
    • Examples include 'PUT', 'POST', or 'DELETE'.

Responses

Request samples

Content type
application/json
{
  • "name": "flopTest",
  • "filter": "drawtext",
  • "args": {
    },
  • "_METHOD": "PUT"
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings, New Filter Created",
  • "filterid": 323
}

Edit Transcoding Profile Filter

Edit Transcoding Profile Filter

Authorizations:
apikeyAuth
path Parameters
filterid
required
string
Example: <string>

(Required) Id of the Transcode Profile filter

header Parameters
Content-Type
string
Example: application/json
Accept
string
Example: application/json
Request Body schema: application/json
name
string
  • Represents the name associated with the operation.
    • Useful for identifying specific tasks or filters applied.
    • Examples include 'flopTest', 'rotateVideo', or 'addLogo'.
filter
string
  • Specifies the type of filter being applied.
    • Provides details about the operation to be performed, such as overlaying text or images.
    • Examples include 'drawtext', 'overlay', or 'crop'.
object
object
url
string
  • URL of the overlay resource (e.g., an image) to be applied to the video. - Empty string indicates no overlay applied. - Examples include 'https://example.com/logo.png' or ''.
scale
string
  • Scale factor for resizing the overlay. - Determines how large the overlay appears on the video. - Examples include '100' (full size) or ''.
position
string
  • Defines the position of the overlay on the video. - Common values include 'Top Left', 'Center', or 'Bottom Right'. - Examples include 'Top Left' or ''.
object
text
string
  • The text content to be displayed on the video. - Can be used for captions, labels, or watermarks. - Examples include 'Testing' or 'Hello World'.
fontsize
integer
  • Size of the font for the text. - Determines how large the displayed text appears. - Examples include 16, 24, or 32.
fontcolor
string
  • Color of the text in hexadecimal format. - Used for styling the text appearance. - Examples include '#42a5f5' (blue) or '#ff0000' (red).
position
string
  • Position of the text on the video. - Can specify alignment such as 'Center', 'Top Left', or 'Bottom Right'. - Examples include 'Center' or 'Top Left'.
object
url
string
  • URL of the image to be converted into a video format. - If empty, no image-to-video operation is performed. - Examples include 'https://example.com/image.png' or ''.
object
url
string
  • URL of the video to be looped. - Used to specify a source video for repeating playback. - Examples include 'https://example.com/video.mp4' or ''.

Responses

Request samples

Content type
application/json
{
  • "name": "flopTest",
  • "filter": "drawtext",
  • "args": {
    }
}

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}

Edit Transcoding Profile Filter

Delete the information of Transcoding Profile filter. To cast request method POST and parameters _METHOD = DELETE

Authorizations:
apikeyAuth
path Parameters
filterid
required
integer
Example: 323

(Required) Id of the Transcode Profile filter

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "result": "success",
  • "message": "Transcoding Settings Updated"
}