Info - Service catalog | ArcGIS REST APIs

URL:: https://<root>/info
Methods:: GET
Operations:: Health Check
Version Introduced:: 12.0

Description

This info operation outputs information regarding the ArcGIS Video Server. This includes the current version, owning system URL, authentication type, and provides access to the Health Check operation.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The output format for this operation. 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 output format for this operation. 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
`currentVersion`	Lists the current version of the ArcGIS Video Server installation, including any patches.
`fullVersion`	Lists the full version of the ArcGIS Video Server installation.
`owningSystemUrl`	The full URL of the owning system the server is federated with.
`authInfo`	Confirms if token based security is enabled and provides the token service URL. The two properties covered by authInfo are `tokenServicesUrl`, containing the URL used to generate tokens by the server, and `isTokenBasedSecurity`, which provides a `true` or `false` response based upon whether token-based security is currently enabled.

Example usage

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

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

JSON Response syntax

Use dark colors for code blocksCopy
{
    "owningSystemUrl": "<Video Server URL>",
    "fullVersion": "<full version, eg: 12.0.0>",
    "currentVersion": <integer for Video Server version>,
    "authInfo": {
        "tokenServicesUrl": "<URL used for token-based security>",
        "isTokenBasedSecurity": true | false
    }
}

JSON Response example

Use dark colors for code blocksCopy
{
    "owningSystemUrl": "https://samplehostname.arcgis.esri.com/video",
    "fullVersion": "12.0.0",
    "currentVersion": 12,
    "authInfo": {
        "tokenServicesUrl": "https://organization.example.com/video/sharing/rest/generateToken",
        "isTokenBasedSecurity": true
    }
}