Skip To Content
ArcGIS Developer

Join Site

  • URL:https://<notebookserveradmin>/joinSite(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.7.1


The Join Site operation, available starting at 10.7.1, is used to connect an ArcGIS Notebook Server machine to an existing site, creating a multiple-machine site.

Multiple-machine ArcGIS Notebook Server sites allow you to support more simultaneous notebook users. If you have many active users, or if you have modified your site's resource limits to use large containers, 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 need to 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 then returns connection information about its configuration store 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. The only exception is the workspace directory on Windows systems, which must remain on a local path.

If this is the first server machine in your site, use the Create Site operation instead.


The Join Site operation is available only when the server machine is not participating in any site.

Request parameters


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 an administrative account for the site.


The password of the administrative account.


The response format. The default response format is html.

Values: html | json

Response properties


Indicates success or failure of the operation.


Specifies the duration of seconds you must wait before making any additional calls to the server.

JSON Request example


JSON Response example

	"status": "success",
	"pollAfter": 30;