Servers

URL:: https://<root>/federation/servers
Methods:: GET
Operations:: Federate Servers, Validate Servers
Child Resources:: Server
Required Capability:: Access allowed with the "Servers" privilege
Version Introduced:: 10.4

Description

This servers resource returns detailed information about an ArcGIS Server registered with an organization, which includes the following information:

The server's ID
The server's name
The ArcGIS Web Adaptor URL
The server's administrative URL
Whether the server is set as a hosting server
The server role
The server type

Request parameters

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

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/portaladmin/federation/servers?f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "servers": [
    {
      "id": "A5jgUpHKuk8thd8R",
      "name": "machine1.esri.com:6443",
      "url": "https://machine1.esri.com/gis",
      "isHosted": false,
      "adminUrl": "https://machine1.esri.com:6443/arcgis",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": "ImageHosting,KnowledgeServer",
      "serverType": "ArcGIS",
      "webgisServerTrustKey": ""
    },
    {
      "id": "qNToMlTRZivoziTW",
      "name": "machine2.esri.com",
      "url": "https://machine2.esri.com/mission",
      "isHosted": false,
      "adminUrl": "https://machine2.esri.com/mission",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": "MissionServer",
      "serverType": "ARCGIS_MISSION_SERVER",
      "webgisServerTrustKey": ""
    },
    {
      "id": "07YfVcO6qk2iwqF7",
      "name": "machine3.esri.com:6443",
      "url": "https://machine3.esri.com/gis",
      "isHosted": true,
      "adminUrl": "https://machine3.esri.com:6443/arcgis",
      "serverRole": "HOSTING_SERVER",
      "serverFunction": "WorkflowManager",
      "serverType": "ArcGIS",
      "webgisServerTrustKey": ""
    },
    {
      "id": "ij8kEYiPWA94e30S",
      "name": /machine4.esri.com:6443",
      "url": "https://machine4.esri.com/gis",
      "isHosted": false,
      "adminUrl": "https:///machine4.esri.com:6443/arcgis",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": "RasterAnalytics",
      "serverType": "ArcGIS",
      "webgisServerTrustKey": ""
    },
    {
      "id": "zaqghiyLnmIgpfPr",
      "name": "machine2.esri.com",
      "url": "https://machine2.esri.com/video",
      "isHosted": false,
      "adminUrl": "https://machine2.esri.com/video",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": "VideoServer",
      "serverType": "ARCGIS_VIDEO_SERVER",
      "webgisServerTrustKey": ""
    }
  ]
}