Register Machine

URL:
https://<root>/machines/register
Methods:
POST
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.1

Description

The register operation registers a server machine with the site. The server machine must have ArcGIS Server installed and authorized. Registering machines this way is a pull approach to growing the site and allows you to add a large number of machines to a site. In contrast, you can join a server machine to a site.

If the site has registered Relational Data Store Types and more machines are added, you must completely restart ArcGIS Server on each newly registered machine. To do this, restart the Windows service or use the stopserver/startserver scripts on Linux.

Request parameters

ParameterDescription

machineName

The name of the server machine to be registered with the site. This server machine must have ArcGIS Server installed and authorized.

Example
Use dark colors for code blocksCopy
1
machineName=MACHINE2.DOMAIN.COM

adminURL

The URL where the administrator API is running on the server machine.

Example
Use dark colors for code blocksCopy
1
adminURL=https://machine.domain.com:6443/arcgis/admin

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the register operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/machines/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

machineName=MACHINE2.DOMAIN.COM&adminURL=https://machine.domain.com:6443/arcgis/admin&f=json

JSON Response example

The following is a sample success response for the register operation, indicating that the machine has been registered successfully with the site:

Use dark colors for code blocksCopy
1
2
3
{
  "status": "success"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.