- URL:
- https://<root>/joinSite
- Methods:
POST- 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.
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 join operation connects a server machine to an existing site. This is considered a push mechanism, in which a server machine pushes its configuration to the site. For the operation to be successful, you must provide an account with administrative privileges to the site.
When an attempt is made to join a site, the site validates the administrative credentials, and returns connection information about its configuration store back to the server machine. The server machine then uses the connection information to work with the configuration store. If this is the first server machine in your site, use the Create Site operation instead.
If your site has registered Relational Data Store Types, you must completely restart ArcGIS Server on the newly joined machines. To do this, restart the Windows Service or use the stopserver/startserver scripts on Linux.
Request parameters
| Parameter | Description |
|---|---|
| The site URL of the currently live site. This is typically the Administrator Directory URL of one of the server machines of a site. |
| The name of the administrative account for the site. |
| The password of the administrative account. |
| The response format. The default response format is Values: |
JSON Response syntax
{
"status": "success|failure",
"pollAfter": <seconds>
}JSON Response example
The following is a sample success response for the join operation, indicating that the server machine joined the site successfully:
{
"status": "success",
"pollAfter": 10
}