Skip To Content
ArcGIS Developers
Dashboard

/[serverID]: Server

Example usage

Below is a sample ArcGIS Enterprise request URL used to access an individual server resource:

htpps://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/servers/J5TUOrNQurCDgHFq?f=pjson

Description

This resource represents an ArcGIS Server site that has been federated with the portal.

Note:

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

Request parameters

ParameterDetails
f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails
id

The ID of the ArcGIS Server 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.

adminUrl

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

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).

serverKey

The key returned when the Register Server operation is called for this server. The key is only displayed once; hence, this property usually returns null.

serverType

The server type.

Values: ArcGIS | ARCGIS_NOTEBOOK_SERVER | ARCGIS_MISSION_SERVER

serverRole

The role of the server.

Values: STANDALONE_SERVER | FEDERATED_SERVER | FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING | HOSTING_SERVER

serverFunction

The function of the server.

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

JSON Response syntax

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

JSON Response example

{
  "id": "J5TUOrNQurCDgHFq",
  "name": "myserver.mydomain.com:6443",
  "adminUrl": "https://myserver.mydomain.com:6443/arcgis",
  "url": "https://myserver.mydomain.com/arcgis",
  "isHosted": true,
  "serverKey": "null",
  "serverType": "ArcGIS",
  "serverRole": "HOSTING_SERVER",
  "serverFunction": "GeoAnalytics"
}