- URL:https://<root>/joinSite
- Required Capability:Default administrator role
- Version Introduced:10.4
Description
Caution:
This operation cannot be performed if this is the first portal machine registered to the site. The first portal machine of a site must use the Create Site operation instead.
The joinSite operation performs the following tasks when invoked:
- Registers a machine to an existing site (active machine)
- Creates a snapshot of the database of the active machine
- Updates the token shared key
- Updates Web Adaptor configurations
- Sets up replication to keep the database of both machines in sync
You must provide an account with administrative privileges to the site for the operation to be successful. When an attempt is made to join a site, the site validates the administrative credentials of the user invoking the operation. Once the administrative credentials are validated, the site returns connection information about its configuration store back to the portal machine. The portal machine then uses the connection information to work with the configuration store.
The operation is time-consuming as the database is configured on the machine and all configurations are applied from the active machine. After the operation is complete, the web server that hosts the API will be restarted.
Request parameters
| Parameter | Details |
|---|---|
| machineAdminUrl | The admin URL of the existing portal site to which a machine will be joined Example |
| username | The username for the initial administrator account of the existing portal site. Example |
| password | The password for the initial administrator account of the existing portal site. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
The following is a sample request URL for the joinSite operation:
https://webadaptor.domain.com/webadaptor/portaladmin/joinSite?machineAdminUrl=https://portalhost.domain.com:7443&username=admin&password=admin.secret&f=jsonJSON Response example
{
"status": "success",
"recheckAfterSecs": 10
}