Server Protocols | ArcGIS REST APIs

URL:: https://<root>/system/livestream/serverProtocols
Methods:: GET
Operations:: Update
Version Introduced:: 12.0

Description

The serverProtocols resource displays to administrators whether WebRTC, HTTPS, Secure Reliable Transport (SRT), User Datagram Protocol (UPD), Real-Time Messaging Protocol (RTMP, RTMPS), and Real-Time Streaming Protocol (RTSP, RTSPS) livestreams are enabled or disabled.

Request parameters

Parameter Details

Parameter	Details
`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.

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/system/livestream/serverProtocols?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
}