ArcGIS REST API

Machine

Description

A server machine represents a machine on which ArcGIS Server software has been installed and licensed. A site is composed of one or more server machines that work together to host GIS services and data and provide administrative capabilities for the site. Each server machine is capable of performing all these tasks, and a site can be thought of as a distributed peer-to-peer network of such machines.

A server machine communicates with its peers over a range of TCP and UDP ports that can be configured using the edit operation. Starting and stopping the server machine enables and disables, respectively, its ability to host GIS services.

The administrative capabilities of the server machine are available through the ArcGIS Server Administrator Directory that can be accessed over HTTP or HTTPS. For a server machine to participate in a site, it must be registered with the site. A machine can participate in only one site at a time. To remove a machine permanently from a site, you can use the unregister operation.

Parameters

ParameterDescription
f

The response format. The default response format is html.

Values: html | json

Response format

{
    "machineName": "<name>",
    "platform": "<OS platform>",
    "adminURL": "<URL>",
    "ports": { 
        "<name1>":"<value>",
        "<name2>":"<value>",...
    } 
  "ServerStartTime": <value>,
  "webServerMaxHeapSize": <value>,
  "appServerMaxHeapSize": <value>,
  "socMaxHeapSize": <value>,
  "webServerSSLEnabled": <true|false>,
  "webServerCertificateAlias": <value>,
  "adminURL": <URL>,
  "configuredState": <"STARTED"|"STOPPED">,
  "synchronize": <true|false>,
  "underMaintenance": <true|false>}

Example

{
    "machineName": "SERVER1.DOMAIN.COM",
    "platform": "Windows Server 2008 R2-amd64-6.1",
    "adminURL": "https://SERVER1.DOMAIN.COM:6443/arcgis/admin",
    "ports": {
        "HTTP": 6080,
        "webSocketsPort": 6180,
        "HTTPS": 6443
    },
  "ServerStartTime": 1540391261590,
  "webServerMaxHeapSize": -1,
  "appServerMaxHeapSize": 256,
  "socMaxHeapSize": 64,
  "webServerSSLEnabled": true,
  "webServerCertificateAlias": "SelfSignedCertificate",
  "adminURL": "https://server1.domain.com:6443/arcgis/admin",
  "configuredState": "STARTED",
  "synchronize": false,
  "underMaintenance": false
}