Self | ArcGIS REST APIs | Esri Developer

URL:: https://<root>/self
Methods:: GET
Version Introduced:: 12.0

Description

The self resource outputs information regarding ArcGIS Video Server. This includes the GPU status, registered data stores, the ID of the default data store, and the maximum file size for uploads.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The response format. The default value 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 value 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.

Response properties

Property	Details
`canTranscode`	States whether or not ArcGIS Video Server machine has a NVIDIA GPU which supports transcoding. GPU drivers need to be updated consistently and this can output `false` due to an insufficient driver version. Values: `true` \| `false`
`h264Encoding`	States whether ArcGIS Video Server supports H264 encoding. Values: `true` \| `false`
`h265Encoding`	States whether ArcGIS Video Server supports H265 encoding. Values: `true` \| `false`
`gpuInfo`	Outputs the information ArcGIS Video Server has attained regarding the machine's name, GPU type, and whether or not transcoding is supported by the GPU.
`elevationSources`	Outputs a list of all elevation sources registered with ArcGIS Video Server.
`registeredDataStores`	Lists the available data stores which are registered with ArcGIS Video Server.
`defaultDataStoreId`	Outputs the ID of the current default data store.
`maxFileUploadSize`	The maximum allowed upload size for any video files uploaded to ArcGIS Video Server.
`livestreamPorts`	Lists the ports being used for livestream protocols. These can be manually changed by an administrator at the Update Server Ports endpoint.
`serverModeProtocols`	States whether an administrator has enabled the following server mode livestream protocols: RTMP RTSP UDP SRT Which protocols are enabled can be modified using the Update Server Protocols endpoint.
`clientModeProtocols`	States whether an administrator has enabled the following client mode livestream protocols: RTMP RTMPS RTSP RTSPS HTTPS Which protocols are enabled can be modified using the Update Client Protocols endpoint.

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com:21443/arcgis/rest/self?f=pjson

Response syntax

Use dark colors for code blocksCopy
{
    "serverModeListeners": {
        "rtmp": "< true | false >",
        "udp": "< true | false >",
        "srt": "< true | false >",
        "rtsp": "< true | false >"
    },
    "serverModeProtocols": {
        "rtmp": "< true | false >",
        "udp": "< true | false >",
        "srt": "< true | false >",
        "rtsp": "< true | false >"
    },
    "codecs": {
        "h264": "< true | false >",
        "h265": "< true | false >"
    },
    "maxFileUploadSize": "maximum file upload size in MB",
    "livestreamPorts": {
        "rtmp": "port",
        "rangeMax": "port",
        "rangeMin": "port",
        "rtsp": "port"
    },
    "clientModeProtocols": {
        "rtmp": < true | false >,
        "rtmps": < true | false >,
        "rtsps": < true | false >,
        "rtsp": < true | false >,
        "https": < true | false >
    },
    "datastores": [
        {
            "name": "datastoreName",
            "id": "datastore ID",
            "type": "< FILESYSTEM | OBJECT | CLOUD >"
        },
        {
            "name": "datastoreName2",
            "id": "datastore ID",
            "type": "< FILESYSTEM | OBJECT | CLOUD >"
        }
    ],
    "defaultDatastoreId": "default Datastore ID",
    "canTranscode": "< true | false >",
    "elevationSources": "elevationSource ID",
    "gpuInfo": [{
        "machine": "machine name",
        "message": "potential error messages",
        "gpu": "detected gpu name",
        "canTranscode": "< true | false >"
    }]
}

Response example

Use dark colors for code blocksCopy
{
    "serverModeListeners": {
        "rtmp": true,
        "udp": true,
        "srt": true,
        "rtsp": true
    },
    "serverModeProtocols": {
        "rtmp": true,
        "udp": true,
        "srt": true,
        "rtsp": true
    },
    "codecs": {
        "h264": true,
        "h265": true
    },
    "maxFileUploadSize": 10000,
    "livestreamPorts": {
        "rtmp": 1935,
        "rangeMax": 65535,
        "rangeMin": 49152,
        "rtsp": 554
    },
    "clientModeProtocols": {
        "rtmp": true,
        "rtmps": true,
        "rtsps": true,
        "rtsp": true,
        "https": true
    },
    "datastores": [
        {
            "name": "0123456789abcdef",
            "id": "c0c87142-d1af-445d-a975-d7b249aae3ba",
            "type": "OBJECTSTORE"
        },
        {
            "name": "Video Server Config Store",
            "id": "11e9c5f0-9969-4610-927d-8e518310d67a",
            "type": "FILESYSTEM"
        }
    ],
    "defaultDatastoreId": "11e9c5f0-9969-4610-927d-8e518310d67a",
    "canTranscode": true,
    "elevationSources": "930c3ee0a2b1463a87d193ea0a2e687f",
    "gpuInfo": [{
        "machine": "ORGANIZATION.EXAMPLE.COM",
        "message": "",
        "gpu": "Quadro T1000",
        "canTranscode": true
    }]
}