Machines | ArcGIS REST APIs

URL:: https://<root>/machines
Methods:: GET
Child Resources:: Machine
Version Introduced:: 12.0

Description

The machines resource returns a list of all machines associated with 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
`machines`	The primary response provided. All additional properties are nested within this `machines` JSON array.
`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`
`configuredState`	This property indicates whether a machine is currently stopped or started. Values: `STARTED` \| `STOPPED`
`webServerMaxHeapSize`	Indicates the maximum heap size set on the server machine. `-1` indicates that the size is not being artificially limited.
`webServerCertificateAlias`	Outputs the alias of the currently associated domain certificate used by the server machine.
`adminUrl`	This property indicates the administrative URL associated with the server machine for the purpose of federation.
`machineName`	The hostname of the machine in question.
`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 machines resource:

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

JSON Response syntax

Use dark colors for code blocksCopy
{
  "machines": [{
    "underMaintenance": "< true | false >",
    "configuredState": "< STARTED | STOPPED >",
    "webServerMaxHeapSize": "integer",
    "webServerCertificateAlias": "domain_certificate",
    "adminURL": "https://organization.example.com:21443/arcgis/admin",
    "machineName": "organization.example.com",
    "synchronize": "< true | false >"
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "machines": [{
    "underMaintenance": false,
    "configuredState": "STARTED",
    "webServerMaxHeapSize": -1,
    "webServerCertificateAlias": "domain_cert",
    "adminURL": "https://organization.example.com:21443/arcgis/admin",
    "machineName": "organization.example.com",
    "synchronize": false
    }
  ]
}