Skip to content
URL:
https://<root>/system/livestream/clientProtocols
Methods:
GET
Operations:
Update
Version Introduced:
12.0

Description

The clientProtocols resource allows administrators to list whether or not HTTPS, Real-Time Messaging Protocol (RTMP, RTMPS), and Real-Time Streaming Protocol (RTSP, RTSPS) livestreams are enabled or disabled.

Request parameters

ParameterDetails

f

(Required)

The response format. The default response format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Example usage

The following is a sample request URL used to access the clientProtocols resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/system/livestream/clientProtocols?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
    "rtmp": "< true | false >",
    "rtmps": "< true | false >",
    "rtsps": "< true | false >",
    "rtsp": "< true | false >",
    "https": "< true | false >"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
    "rtmp": true,
    "rtmps": true,
    "rtsps": true,
    "rtsp": true,
    "https": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.