ArcGIS REST API

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.

Response Properties

PropertyDetails
servers

An array of JSON objects representing ArcGIS Server sites. Each JSON object has the following properties:

  • 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).
  • adminUrl—The administrative URL of the ArcGIS Server site, using the fully qualified name of the machine.
  • serverRole—The role of the specified server. Roles include:
    • STANDALONE_SERVER
    • FEDERATED_SERVER
    • FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING
    • HOSTING_SERVER
  • serverFunction—The function of the specified server. Server functions include:
    • RasterAnalytics
    • GeoAnalytics
    • GeoEvent
    • GISServer
    • ImageHosting

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": ""
}
]}