/register: Register Server

URL:: https://[root]/portals/[portalID]/servers/register
Methods:: POST

Example usage

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

Use dark colors for code blocksCopy
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

The register operation registers (or federates) 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.

Request parameters

Parameter	Details
`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 Use dark colors for code blocksCopy `1 name=machine.domain.com:6443`
`url`	The externally visible URL of the ArcGIS Server site, using the fully qualified name of the machine. Example Use dark colors for code blocksCopy `1 url=https://machine.domain.com/webadaptor`
`adminUrl`	The administrative URL of your ArcGIS Server site, using the fully qualified name of the machine. Example Use dark colors for code blocksCopy `1 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

Property	Details
`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

Use dark colors for code blocksCopy
{
  "success": <true | false>,
  "serverId": <serverId>,
  "secretKey": <secretKey>
}

JSON Response example

Use dark colors for code blocksCopy
{
  "success": true,
  "serverId": "J5TUOrNQurCDgHFq",
  "secretKey": "8ca3030b618e4a8ab86a2f5052d47d21"
}