Federate Servers

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

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. 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
1
2
3
4
5
6
7
8
//Fully qualified machine name
url=https://machine.domain.com/arcgis

//URL includes Web Adaptor address
url=https://machine.domain.com/gis

//URL is the reverse proxy server address
url=https://reverseproxy.domain.com/myorg

adminUrl

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 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
1
adminUrl=https://gisserver.domain.com:6443/arcgis

username

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
1
username=administrator

password

The password of the primary site administrator account.

Example
1
password=adminpassword

f

The response format. The default response value is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the federate operation:

1
2
3
4
5
6
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

1
2
3
4
5
{
  "status": "success",
  "serverId": "iSoD09CM73g0tmu9",
  "messages": "..."
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close