- URL:https://<admin-url>/joinSite(POST only)
- Required Capability:Administrator
Description
The joinSite 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 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, then 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.
Note:
The joinSite operation is available only when a server machine is not participating in any site.Request parameters
| Parameter | Description |
|---|---|
| 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 an 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 |
JSON Response syntax
{
"status": "success|failure"
}JSON Response example
{
"status": "success"
}