Skip to content
URL:
https://<root>/system/livestream/clientProtocols/update
Methods:
POST
Version Introduced:
12.0

Description

The update operation allows administrators to manually enable or disable HTTPS, Real-Time Messaging Protocol (RTMP, RTMPS), and Real-Time Streaming Protocol (RTSP, RTSPS) livestreams.

Request parameters

ParameterDetails

rtmpEnabled

(Required)

Determines whether RTMP streams are enabled.

Values: true | false

rtmpsEnabled

(Required)

Determines whether RTMPS streams are enabled.

Values: true | false

rtspEnabled

(Required)

Determines whether RTSP streams are enabled.

Values: true | false

rtspsEnabled

(Required)

Determines whether RTSPS streams are enabled.

Values: true | false

httpsEnabled

(Required)

Determines whether HTTPS streams are enabled.

Values: true | false

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 update operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /arcgis/admin/system/livestream/clientProtocols/update HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-www-form-urlencoded
Content-Length: []

rtmpEnabled=true&rtmpsEnabled=true&rtspEnabled=true&rtspsEnabled=true&httpsEnabled=true&f=pjson&token=<token>

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.