/[serverID]: Server

URL:: https://[root]/portals/[portalID]/servers/[serverID]
Methods:: GET
Operations:: Unregister Server, Update Server

Example usage

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

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

Description

The resource for an individual server represents an ArcGIS Server site that has been federated with the organization.

Request parameters

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

Response properties

Property	Details
`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`
`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
{
  "id": "<serverId>",
  "name": "<serverName>",
  "adminUrl": "<serverAdminUrl>",
  "url": "<serverUrl>",
  "isHosted": <true|false>,
  "serverKey": "<serverKey>",
  "serverType": "<serverType>",
  "serverRole": "<serverRole>",
  "serverFunction": "<serverFunction>",
  "adminPublicUrl": "<serverAdminPublicUrl>"
}

JSON Response example

The following sample response for an individual server resource is returned by an ArcGIS Enterprise:

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

The following sample JSON response is returned an individual server resource in an ArcGIS Enterprise on Kubernetes deployment:

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