Skip To Content ArcGIS for Developers Sign In Dashboard

Servers

Description

This resource lists the ArcGIS Server sites that have been federated with the portal.

This resource is not applicable to ArcGIS Online; it is only applicable to ArcGIS Enterprise.

Request parameters

ParameterDetails
[Common Parameters]

For a complete listing, see Common parameters.

Server response properties

The server resource returns an array of JSON objects representing ArcGIS Server sites. Each JSON object has the following properties:

PropertyDetails
id

A unique identifier for the site.

name

The fully qualified name of the machine hosting the ArcGIS Server site, followed by the port.

url

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

isHosted

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

Values: true | false

adminURL

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

serverRole

The role of the specified server.

Values: STANDALONE_SERVER | FEDERATED_SERVER | FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING | HOSTING_SERVER

serverFunction

The function of the specified server.

Values: RasterAnalytics | GeoAnalytics | GeoEvent | GISServer | ImageHosting | NotebookServer

Example usage

https://myportal.mydomain.com/arcgis/sharing/rest/portals/0123456789ABCDEF/servers

JSON Response syntax

{"servers": [{
  "id": <serverId>,
  "name": <serverName>,
  "url": <serverUrl>,
  "isHosted": true | false,
  "adminUrl": <serverAdminUrl>,
  "serverRole": <serverRole>,
  "serverFunction": <serverFunction>
}]}

JSON Response example

{"servers": [{
  "id": "J5TUOrNQurCDgHFq",
  "name": "myserver03.mydomain.com:6080",
  "url": "https://myserver03.mydomain.com/arcgis",
  "isHosted": true,
  "adminUrl": "https://myserver03.mydomain.com:6080/arcgis",
  "serverRole": "HOSTING_SERVER",
  "serverFunction": ""
},
{
  "id": "gL9t5ZagFy5l5sdc",
  "name": "myserver02.mydomain.com:6443",
  "url": "https://myserver02.mydomain.com/server",
  "isHosted": false,
  "adminUrl": "https://myserver02.mydomain:6443/arcgis",
  "serverRole": "FEDERATED_SERVER",
  "serverFunction": "RasterAnalytics"
},
{
  "id": "raIO3wdpmyX0riGw",
  "name": "myserver01.mydomain.com:6443",
  "url": "https://myserver01.mydomain.com/server",
  "isHosted": false,
  "adminUrl": "https://myserver01.mydomain.com:6443/arcgis",
  "serverRole": "FEDERATED_SERVER",
  "serverFunction": ""
}
]}