Skip To Content
ArcGIS Developers
Dashboard

Federate Servers

Description

This operation enables ArcGIS Server to be federated with Portal for ArcGIS.

Request parameters

ParameterDetails
url

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, for example, https://webadaptor.domain.com/arcgis. If you've added ArcGIS Server to your organization's reverse proxy server, the URL is the reverse proxy server address (for example, https://reverseproxy.domain.com/myorg). 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 Portal for ArcGIS 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

url=https://webadaptor.domain.com/arcgis
adminUrl

The URL used for accessing ArcGIS Server when performing administrative operations on the internal network, for example, https://gisserver.domain.com:6443/arcgis.

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 adminUrl must be a URL that the portal can use to communicate with all servers in the site, even when one of them is unavailable. If you use a Web Adaptor for this URL, ensure that you have enabled administrative access to the server through the Web Adaptor.

Example

adminUrl=https://gisserver.domain.com:6443/arcgis
username

The username of the primary site administrator account that was used to initially log in to Manager and administer ArcGIS Server. If this account is disabled, you'll need to re-enable it.

Example

username=administrator
password

The password of the primary site administrator account.

Example

password=adminpassword
f

The response format. The default response value is html.

Values: html | json | pjson

Example usage

Below is a sample request URL for federate:

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/webadaptor&adminUrl=https://machine.domain.com:6443/arcgis&username=administrator&password=adminpassword&f=json

Response values

Possible status responses include:

  • success
  • success with warnings - This response was added at 10.6.1.
  • failure
  • undetermined

JSON Response syntax

{
  "status": "success",
  "serverId": "iSoD09CM73g0tmu9",
  "messages": "..." //Added in 10.6.1
}