servers: Servers

URL:: https://[root]/portals/[portalID]/servers
Methods:: GET
Operations:: Register Server
Child Resources:: Server

Example usage

The following is a sample ArcGIS Enterprise request URL used to access the servers resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/servers?f=pjson

Description

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

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Server response properties

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

Property	Details
`id`	A unique identifier for the site.
`name`	A user-provided name for the server, with a limit of 250 characters. This parameter also supports the use of double-byte characters.
`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.
`serverType`	The type of server registered with the portal. Values: `ArcGIS` \| `ARCGIS_NOTEBOOK_SERVER` \| `ARCGIS_MISSION_SERVER`
`serverRole`	The role of a specific server. Values: `STANDALONE_SERVER` \| `FEDERATED_SERVER` \| `FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING` \| `HOSTING_SERVER`
`serverFunction`	The function of a specific server. Values: `RasterAnalytics` \| `GeoEvent` \| `GISServer` \| `ImageHosting` \| `NotebookServer` \| `MissionServer` \| `WorkflowManager` \| `GeoAnalytics` (Deprecated at 11.4)
`adminPublicUrl`	Introduced at 10.9.1. The administrative public URL used by federated servers to communicate with ArcGIS Enterprise on Kubernetes hosted services. This property is supported when the server role is set as `hosting_server` and an organization-level `privatePortalURL` is set. This property is typically configured to use the `privatePortalURL` when ArcGIS Enterprise on Kubernetes is configured for web-tier authentication. This property is only applicable to ArcGIS Enterprise on Kubernetes deployments.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "servers": [
    {
      "id": "<serverId>",
      "name": "<serverName>",
      "url": "<serverUrl>",
      "isHosted": <true|false>,
      "adminUrl": "<serverAdminUrl>",
      "serverType": "<serverType>",
      "serverRole": "<serverRole>",
      "serverFunction": "<serverFunction>",
      "adminPublicUrl": "<serverAdminPublicUrl>" //Introduced at 10.9.1. Only supported for
    }
  ]
}

JSON Response example

The sample response for the servers resource is returned by an ArcGIS Enterprise:

Use dark colors for code blocksCopy
{
  "servers": [
    {
      "id": "J5TUOrNQurCDgHFq",
      "name": "myserver03.mydomain.com:6080",
      "url": "https://myserver03.mydomain.com/arcgis",
      "isHosted": true,
      "adminUrl": "https://myserver03.mydomain.com:6080/arcgis",
      "serverType": "ArcGIS",
      "serverRole": "HOSTING_SERVER",
      "serverFunction": ""
    },
    {
      "id": "gL9t5ZagFy5l5sdc",
      "name": "myserver02.mydomain.com:11443",
      "url": "https://myserver02.mydomain.com/server",
      "isHosted": false,
      "adminUrl": "https://myserver02.mydomain:11443/arcgis",
      "serverType": "ARCGIS_NOTEBOOK_SERVER",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": "RasterAnalytics"
    },
    {
      "id": "raIO3wdpmyX0riGw",
      "name": "myserver01.mydomain.com:20443",
      "url": "https://myserver01.mydomain.com/server",
      "isHosted": false,
      "adminUrl": "https://myserver01.mydomain.com:20443/arcgis",
      "serverType": "ARCGIS_MISSION_SERVER",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": ""
    }
  ]
}

The following sample JSON response is returned by the servers resource in an ArcGIS Enterprise on Kubernetes deployment:

Use dark colors for code blocksCopy
{
  "servers": [
    {
      "id": "zJSrbFZiKpjXPrJD",
      "name": "organization.domain.com",
      "adminUrl": "https://private-ingress.domain.com/context/",
      "url": "https://organization.domain.com/context",
      "isHosted": true,
      "serverType": "ArcGIS",
      "serverRole": "HOSTING_SERVER",
      "serverFunction": "",
      "adminPublicUrl": "https://organization.domain.com/context"
    }
  ]
}