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 machines resource represents a collection of all the server machines that have been registered with the site; that is, it represents the total computing power of your site. A site will continue to run as long as there is one server machine online.
The list of server machines in your site can be dynamic. You can register additional server machines when you need to increase the computing power of your site or unregister them if you no longer need them.
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 the machines resource:
https://organization.example.com/<context>/admin/machines?f=pjsonJSON Response syntax
{
"machines": [ <machine1>, <machine2>, ...]
}JSON Response example
{
"machines": [
{
"machineName": "MACHINE.EXAMPLE.COM",
"adminURL": "https://MACHINE.EXAMPLE.COM:6443/arcgis/admin"
},
{
"machineName": "MACHINE2.EXAMPLE.COM",
"adminURL": "https://MACHINE2.EXAMPLE.COM:6443/arcgis/admin"
}
]
}