- URL:
- https://<root>/federation/servers/federate
- Methods:
POST
- Required Capability:
- Access allowed with the "Servers" privilege
- Version Introduced:
- 10.4
Description
The federate
operation enables an ArcGIS Server to be federated with an organization.
Request parameters
Parameter | Details |
---|---|
| The URL of the GIS server used by external users when accessing the ArcGIS Server site. If the site includes the Web Adaptor, the URL includes the Web Adaptor address. If you've added ArcGIS Server to your organization's reverse proxy server, the URL is the reverse proxy server address. Note that the federation operation will perform a validation check to determine if the provided URL is accessible from the server site. If the resulting validation check fails, a warning will be generated in the logs. However, federation will not fail if the URL is not validated, as the URL may not be accessible from the server site, such as is the case when the server site is behind a firewall. Example
|
| The URL used for accessing ArcGIS Server when performing administrative operations on the internal network. If you federate with a multimachine site or highly available GIS Server, use the Web Adaptor or load balancer URL in this field instead. The Example
|
| The username of the primary site administrator account that was used to initially log in to ArcGIS Server Manager and administer the server. If this account is disabled, you'll need to re-enable it. Example
|
| The password of the primary site administrator account. Example
|
| The response format. The default response value is Values: |
Example usage
The following is a sample POST request for the federate
operation:
POST /webadaptor/portaladmin/federation/servers/federate HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
url=https://machine.domain.com/gis&adminUrl=https://machine.domain.com:6443/arcgis&username=administrator&password=adminpassword&f=json
Response values
Possible status
responses include:
success
success with warnings
failure
undetermined
JSON Response syntax
{
"status": "success",
"serverId": "iSoD09CM73g0tmu9",
"messages": "..."
}