Machine | ArcGIS REST APIs

URL:: https://<root>/machines/<machine>
Methods:: GET
Operations:: Edit, Unregister
Child Resources:: SSL Certificates, Hardware, GPU Limit Info, Tool Status
Version Introduced:: 12.0

Description

This resource can be utilized to generate a list of all properties associated with a specific machine in an ArcGIS Video Server site.

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
`underMaintenance`	This property shows whether a machine has been set to maintenance mode at the time the request is sent. Maintenance mode will prevent non-administrative users from making any changes to the site. Values: `true` \| `false`
`gpuName`	If a GPU is detected on the machine, this property will output the name of the GPU hardware.
`h265Encoding`	This property indicates whether or not h265 encoding is supported by the machine's GPU. Values: `true` \| `false`
`webServerMaxHeapSize`	Indicates the maximum heap size set on the server machine. `-1` indicates that the size is not being artificially limited.
`message`	If a message has been assigned to the machine, it will be output as part of this property.
`machineName`	The hostname of the machine in question.
`h264Encoding`	This property indicates whether h264 encoding is supported by the machine's GPU. Values: `true` \| `false`
`configuredState`	This property indicates whether a machine is currently stopped or started. Values: `STARTED` \| `STOPPED`
`numVideoProcessors`	This property lists the number of available video processors as an integer.
`webServerCertificateAlias`	Outputs the alias of the currently associated domain certificate used by the server machine.
`videoProcessorRunning`	Indicates whether a machine's video processing is enabled at a given time. Values: `true` \| `false`
`adminUrl`	This property indicates the administrative URL associated with the server machine for the purpose of federation.
`isGPU`	Indicates whether a machine has a detected GPU. Values: `true` \| `false`
`synchronize`	Indicates whether a machine is set to synchronize with other machines associated with ArcGIS Video Server. Values: `true` \| `false`

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/video/admin/machines/organization.example.com?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
    "underMaintenance": "< true | false >",
    "gpuName": "GPU Name",
    "h265Encoding": "< true | false >",
    "webServerMaxHeapSize": "integer",
    "message": "string",
    "machineName": "organization.example.com",
    "h264Encoding": "< true | false >",
    "configuredState": "< STARTED | STOPPED >",
    "numVideoProcessors": "integer",
    "webServerCertificateAlias": "Domain Certificate Name",
    "videoProcessorRunning": "< true | false >",
    "adminURL": "https://organization.example.COM:21443/arcgis/admin",
    "isGPU": "< true | false >",
    "synchronize": "< true | false >"
}

JSON Response example

Use dark colors for code blocksCopy
{
    "underMaintenance": false,
    "gpuName": "Quadro T1000",
    "h265Encoding": true,
    "webServerMaxHeapSize": -1,
    "message": null,
    "machineName": "organization.example.com",
    "h264Encoding": true,
    "configuredState": "STARTED",
    "numVideoProcessors": 1,
    "webServerCertificateAlias": "domain_certificate",
    "videoProcessorRunning": true,
    "adminURL": "https://organization.example.com:21443/arcgis/admin",
    "isGPU": true,
    "synchronize": false
}