- URL:
- https://<root>/joinSite
- Methods:
POST
- Required Capability:
- Access allowed only with the default administrator role
- Version Introduced:
- 10.1
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
}