Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the servers resource:
https://organization.example.com/<context>/admin/orgs/0123456789ABCDEF/federation/servers?f=pjsonJSON Response example
The example below demonstrates a response that is returned by servers when the organization has one federated server:
{
"servers": [
{
"serverRole": "FEDERATED_SERVER",
"webgisServerTrustKey": "",
"isHosted": false,
"name": "gisserver.example.com:6443",
"id": "6DdBQL7vPJu2meMS",
"adminUrl": "https://organization.example.com:6443/context",
"serverFunction": "",
"url": "https://organization.example.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": []}