- URL:
- https://<root>/machines/<machine>
- Methods:
GET- Operations:
- Edit, Start, Stop, Unregister, Synchronize With Site
- Child Resources:
- Hardware, SSL Certificates
- Version Introduced:
- 10.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The resource for an individual machine returns the information for a server machine and provides access to various operations that can be used to manage the server machine. 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.
Request parameters
| Parameter | Description |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access an individual server machine resource:
https://organization.example.com/<context>/admin/machines/MACHINE.EXAMPLE.COM?f=pjsonJSON Response syntax
{
"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>
}JSON Response example
{
"machineName": "MACHINE.EXAMPLE.COM",
"platform": "Windows Server 2008 R2-amd64-6.1",
"adminURL": "https://MACHINE.EXAMPLE.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://machine.example.com:6443/arcgis/admin",
"configuredState": "STARTED",
"synchronize": false,
"underMaintenance": false
}