Validate Server

URL:: https://<root>/federation/servers/<serverID>/validate
Methods:: GET
Required Capability:: Access allowed with the "Servers" privilege
Version Introduced:: 10.4

Description

The validate operation provides status information about a specific ArcGIS Server federated with an organization, returning its status and accessibility information. The response will also return failure messages for any failed validation checks. Starting at ArcGIS Enterprise 11.1, this operation's response includes the adminUrl property, which specifies the administrative URL for the federated server.

Request parameters

Parameter	Details
`f`	The response format. The default 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/A5jgUpHKuk8thd8R/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",
    "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"
}