Update - Server Protocols | ArcGIS REST APIs

URL:: https://<root>/system/livestream/serverProtocols/update
Methods:: POST
Version Introduced:: 12.0

Description

The update operation allows administrators to manually enable or disable WebRTC, Secure Reliable Transport (SRT), User Datagram Protocol (UPD), Real-Time Messaging Protocol (RTMP, RTMPS), and Real-Time Streaming Protocol (RTSP, RTSPS) livestreams. These protocols specifically affect server mode livestreams.

Request parameters

Parameter Details

Parameter	Details
`rtmpEnabled` (Required)	Determines whether RTMP streams are allowed in Server Mode. Values: `true` \| `false`
`rtmpListenEnabled` (Required)	Determines whether listening for RTMP streams is allowed in Server Mode. Values: `true` \| `false`
`rtspEnabled` (Required)	Determines whether RTSP streams are allowed in Server Mode. Values: `true` \| `false`
`rtspListenEnabled` (Required)	Determines whether listening for RTSP streams is allowed in Server Mode. Values: `true` \| `false`
`srtEnabled` (Required)	Determines whether SRT streams are allowed in Server Mode. Values: `true` \| `false`
`srtListenEnabled` (Required)	Determines whether listening for SRT streams is allowed in Server Mode. Values: `true` \| `false`
`udpEnabled` (Required)	Determines whether UDP streams are allowed in Server Mode. Values: `true` \| `false`
`udpListenEnabled` (Required)	Determines whether listening for UDP streams is allowed in Server Mode. Values: `true` \| `false`
`webrtcEnabled` (Required)	Determines whether WebRTC streams are allowed in Server Mode. 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.

rtmpEnabled

(Required)

Determines whether RTMP streams are allowed in Server Mode.

Values: true | false

rtmpListenEnabled

(Required)

Determines whether listening for RTMP streams is allowed in Server Mode.

Values: true | false

rtspEnabled

(Required)

Determines whether RTSP streams are allowed in Server Mode.

Values: true | false

rtspListenEnabled

(Required)

Determines whether listening for RTSP streams is allowed in Server Mode.

Values: true | false

srtEnabled

(Required)

Determines whether SRT streams are allowed in Server Mode.

Values: true | false

srtListenEnabled

(Required)

Determines whether listening for SRT streams is allowed in Server Mode.

Values: true | false

udpEnabled

(Required)

Determines whether UDP streams are allowed in Server Mode.

Values: true | false

udpListenEnabled

(Required)

Determines whether listening for UDP streams is allowed in Server Mode.

Values: true | false

webrtcEnabled

(Required)

Determines whether WebRTC streams are allowed in Server Mode.

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 POST request for the update operation:

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

rtmpEnabled=true&rtmpListenEnabled=true&rtspEnabled=true&rtspListenEnabled=true&srtEnabled=true&srtListenEnabled=true&udpEnabled=true&udpListenEnabled=true&webrtcEnabled=true&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
    "rtmp": <true | false>,
    "udp": <true | false>,
    "rtmpListen": <true | false>,
    "rtspListen": <true | false>,
    "webrtc": <true | false>,
    "srt": <true | false>,
    "srtListen": <true | false>,
    "rtsp": <true | false>,
    "udpListen": <true | false>
}

JSON Response example

Use dark colors for code blocksCopy
{
    "rtmp": true,
    "udp": true,
    "rtmpListen": true,
    "rtspListen": true,
    "webrtc": true,
    "srt": true,
    "srtListen": true,
    "rtsp": true,
    "udpListen": true
}