Servers

URL:
https://<root>/orgs/<orgID>/federation/servers
Methods:
GET
Required Capability:
Access allowed with the "Servers" privilege
Version Introduced:
10.9

Description

The servers resource returns detailed information about your organization's federated servers, such as each server's ID, name, and administration URL. ArcGIS Enterprise on Kubernetes currently supports the following as federated servers:

  • GIS Server
  • Image Server
  • Workflow Manager Server (support added at 11.2)

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:

Use dark colors for code blocksCopy
1
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 servers when the organization has one federated server:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "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.

Use dark colors for code blocksCopy
1
{"servers": []}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.