Skip To Content
ArcGIS Developers
Dashboard

Servers

Description

This resource returns detailed information about the ArcGIS Servers federated with the organization, such as the ID of the server, the server name, and the administration URL. Currently, the only supported server types that can be federated with an organization are GIS and Image Servers.

Note:

The hosting server included in the base deployment of ArcGIS Enterprise on Kubernetes is not listed as built-in servers are not returned by this resource.

Request parameters

ParameterDetails
f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

https://organization.domain.com/context/admin/orgs/0123456789ABCDEF/federation/servers?f=pjson

JSON Response example

The example below demonstrates a response that is returned by the servers when the organization has one federated server:

{
  "servers": [
    {
      "serverRole": "FEDERATED_SERVER",
      "webgisServerTrustKey": "",
      "isHosted": false,
      "name": "machine.domain.com:6443",
      "id": "6DdBQL7vPJu2meMS",
      "adminUrl": "https://organization.domain.com:6443/context",
      "serverFunction": "",
      "url": "https://organization.domain.com/context"
    }
  ]
}

The example response below is returned when there are no federated servers associated with the organization. The hosting server included in the base deployment of ArcGIS Enterprise on Kubernetes will not be returned through either the html or json view of this resource.

{"servers": []}