Skip To Content
ArcGIS Developers
Dashboard

/register: Register Server

  • URL:https://[root]/portals/[portalID]/servers/register(POST only)

Example usage

Below is a sample ArcGIS Enterprise POST request for the register operation:

POST /webadaptor/sharing/rest/portals/0123456789ABCDEF/servers/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=machine.domain.com:6443&url=https://machine.domain.com/webadaptor&isHosted=true&serverType=ArcGIS&adminUrl=https://machine.domain.com:6443/arcgis&f=pjson

Description

You can optionally register (or federate) an ArcGIS Server site with your ArcGIS Enterprise organization. Federating a server provides the following benefits:

  • The server and the portal share the same user store (that of the portal). This results in a convenient single sign-on experience.
  • Any items you publish to the server are automatically shared on the portal.
  • You can optionally allow the server to host tiled map services and feature services published by portal users.

After you register a server with your portal, you must invoke the Update Security Configuration operation on the ArcGIS Server site and configure the site's security store to take advantage of users and roles from the portal.

Note:

This operation is not supported with ArcGIS Online; This operation is only applicable to ArcGIS Enterprise.

Request parameters

ParameterDetails
name

A user-provided name for the server, with a limit of 250 characters. This parameter also supports the use of double-byte characters.

Example

name=machine.domain.com:6443
url

The externally visible URL of the ArcGIS Server site, using the fully qualified name of the machine.

Example

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

The administrative URL of your ArcGIS Server site, using the fully qualified name of the machine.

Example

https://machine.domain.com:6443/arcgis
isHosted

A Boolean property denoting whether the ArcGIS Server site will be allowed to host services for the portal (true) or not be allowed to host services (false).

Values: true | false

serverType

The type of server being registered with the portal.

Values: ArcGIS | ARCGIS_NOTEBOOK_SERVER | ARCGIS_MISSION_SERVER

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
success

A Boolean property indicating whether the registration was successful.

serverId

An ID assigned to the server. You need to supply this when you call Update Security Configuration on the server after performing the registration.

secretKey

A symmetric key used to identify the server. You need to supply this when you call Update Security Configuration on the server after performing the registration.

JSON Response syntax

{
  "success": <true | false>,
  "serverId": <serverId>,
  "secretKey": <secretKey>
}

JSON Response example

{
  "success": true,
  "serverId": "J5TUOrNQurCDgHFq",
  "secretKey": "8ca3030b618e4a8ab86a2f5052d47d21"
}