Validate - Servers

URL:: https://<root>/federation/servers/validate
Methods:: GET
Version Introduced:: 10.4

Access requirements

Required privileges

The Portal 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.

Servers

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal 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 generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

Description

The validate operation returns information on the status of the ArcGIS Server types registered with an organization. Upon completion, this operation returns status and accessibility information for all servers. This response also includes any failure messages from failed validation checks. Starting at ArcGIS Enterprise 11.1, the response includes the adminUrl, which returns the administrative URL for each federated server.

Request parameters

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

Example usage

The following is a sample GET request for the validate operation:

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

Response values

The following list outlines the possible status values included in the operation's response:

success
success with warnings
failure
undetermined

JSON Response example

Use dark colors for code blocksCopy
{
  "status": "success",
  "serversStatus": [
    {
      "status": "success",
      "serverId": "A5jgUpHKuk8thd8R",
      "messages": [
        "ArcGIS Server administration URL 'https://machine1.esri.com:6443/arcgis' is accessible.",
        "Validating Knolwedge Server.",
        "ArcGIS Server 'https://machine1.esri.com:6443/arcgis' version matches with Portal for ArcGIS."
      ],
      "adminUrl": "https://machine1.esri.com:6443/arcgis"
    },
    {
      "status": "success",
      "serverId": "qNToMlTRZivoziTW",
      "messages": [
        "ArcGIS Server administration URL 'https://machine2.esri.com/mission' is accessible.",
        "ArcGIS Server 'https://machine2.esri.com/mission' version is compatible with Portal for ArcGIS."
      ],
      "adminUrl": "https://machine2.esri.com/mission"
    },
    {
      "status": "success",
      "serverId": "07YfVcO6qk2iwqF7",
      "messages": [
        "ArcGIS Server administration URL 'https://machine3.esri.com:6443/arcgis' is accessible.",
        "Validating hosting server.",
        "ArcGIS Server 'https://machine3.esri.com:6443/arcgis' version matches with Portal for ArcGIS.",
        "Verified that server has an ArcGIS Data Store registered as a managed database '/enterpriseDatabases/AGSDataStore_ds_dyilhg3y'.",
        "The server managed database '/enterpriseDatabases/AGSDataStore_ds_dyilhg3y' validated successfully.",
        "Validated that the ArcGIS Server site is not in read-only mode.",
        "Configured missing offlinePackaging helper services with Portal for ArcGIS.",
        "Restarted OfflinePackaging service in the hosting ArcGIS Server.",
        "Validated that the publishing tools service of ArcGIS Server site is started.",
        "Validating GeoAnalytics server.",
        "ArcGIS Server 'https://machine3.esri.com:6443/arcgis' version matches with Portal for ArcGIS.",
        "Verified that the hosting server has a registered spatiotemporal big data store '/nosqlDatabases/AGSDataStore_bigdata_bds_v6r5okz1'."
      ],
      "adminUrl": "https://machine3.esri.com:6443/arcgis"
    },
    {
      "status": "success",
      "serverId": "ij8kEYiPWA94e30S",
      "messages": [
        "ArcGIS Server administration URL 'https://machine4.esri.com:6443/arcgis' is accessible.",
        "Validating RasterAnalytics server.",
        "ArcGIS Server 'https://machine4.esri.com:6443/arcgis' version matches with Portal for ArcGIS.",
        "Verified that the server has a registered raster data store '/rasterStores/_raster_store'."
      ],
      "adminUrl": "https://machine4.esri.com:6443/arcgis"
    },
    {
      "status": "success",
      "serverId": "zaqghiyLnmIgpfPr",
      "messages": [
        "ArcGIS Server administration URL 'https://machine2.esri.com/video' is accessible.",
        "ArcGIS Server 'https://machine2.esri.com/video' version is compatible with Portal for ArcGIS."
      ],
      "adminUrl": "https://machine2.esri.com/video"
    }
  ]
}