PlatformsUpdate Platform

Update Platform

Update the platform of a push stream

curl -X POST "https://api.5centscdn.com/v2/streams/push/1001/platform/1" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "platform[name]": "Custom RTMP",
  "platform[rtmp]": "rtmp://rtmp.5centscdn.com:1935/",
  "platform[key]": "password",
  "platform[auth]": "Y",
  "platform[username]": "admin",
  "platform[password]": "password",
  "platform[vprofiles]": 0,
  "platform[aprofiles]": 0,
  "platform[schedule]": "instant",
  "platform[scheduleontime]": "",
  "platform[scheduleondatetime]": "",
  "platform[provider_id]": 0,
  "platform[video_id]": ""
}'
{
  "result": "success",
  "message": "Platform Updated",
  "warnings": [],
  "errors": []
}
POST
/streams/push/{streamid}/platform/{platformid}
POST
Base URLstring

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

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

Content-Typestring
Required

The media type of the request body

Options: application/json
platform[name]string

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

platform[rtmp]string

The RTMP URL used to establish a connection for streaming live video.

platform[key]string

The key or password used for authentication on the platform.

platform[auth]string

Indicates whether authentication is required. Y means yes, N means no.

platform[username]string

The username used for platform authentication, required when auth is Y.

platform[password]string

The password used with the username for platform authentication.

platform[vprofiles]number

The number of video profiles associated with the platform for video quality or encoding.

platform[aprofiles]number

The number of audio profiles associated with the platform for audio quality or encoding.

platform[schedule]string

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

platform[scheduleontime]string

The scheduled time for the stream. Empty if schedule is instant.

platform[scheduleondatetime]string

The scheduled date and time for the stream. Empty if schedule is instant.

platform[provider_id]number

Identifies the provider associated with the platform. 0 means no provider specified.

platform[video_id]string

The ID of the video associated with the platform. Empty if no video is linked.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

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

Path Parameters

streamidstring
Required

Stream ID

Example:
1001
platformidstring
Required

Platform ID

Example:
1

Body

application/json
platform[name]string

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

Example:
Custom RTMP
platform[rtmp]string

The RTMP URL used to establish a connection for streaming live video.

Example:
rtmp://rtmp.5centscdn.com:1935/
platform[key]string

The key or password used for authentication on the platform.

Example:
password
platform[auth]string

Indicates whether authentication is required. Y means yes, N means no.

Example:
Y
platform[username]string

The username used for platform authentication, required when auth is Y.

Example:
admin
platform[password]string

The password used with the username for platform authentication.

Example:
password
platform[vprofiles]number

The number of video profiles associated with the platform for video quality or encoding.

Example:
0
platform[aprofiles]number

The number of audio profiles associated with the platform for audio quality or encoding.

Example:
0
platform[schedule]string

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

Example:
instant
platform[scheduleontime]string

The scheduled time for the stream. Empty if schedule is instant.

Example:
platform[scheduleondatetime]string

The scheduled date and time for the stream. Empty if schedule is instant.

Example:
platform[provider_id]number

Identifies the provider associated with the platform. 0 means no provider specified.

Example:
0
platform[video_id]string

The ID of the video associated with the platform. Empty if no video is linked.

Example:

Responses

resultstring

Status of the API response.

messagestring

Human-readable message describing the result.

warningsstring[]

Non-fatal warnings returned with the response.

errorsstring[]

Errors returned with the response.