URL:
https://<root>/joinSite
Methods:
POST
Required Capability:
Administrator
Version Introduced:
12.2

Description

The joinSite operation connects a server machine to an existing site. Multiple-machine ArcGIS Data Pipelines Server sites allow you to support more simultaneous data pipeline users. If you have many active users, or if you have modified your site's resource limits to leverage all of your available resources on a single machine and still require more resources, you may find a multiple-machine site beneficial.

This operation is 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.

Ensure that each machine you join to a site has read and write privileges to the site's configuration store and server directories, which should all be on shared paths.

Request parameters

ParameterDescription

adminURL

The site URL of the currently live site. This is typically the Administrator Directory URL of one of the server machines of a site.

username

The name of the administrative account for the site.

password

The password of the administrative account.

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is an example POST request for the joinSite operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/joinSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

adminURL=https://organization.example.com:14443/arcgis/admin&username=administrator&password=secret&f=json

JSON Response syntax

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

JSON Response example

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.