- URL:
- https://<root>/federation/servers/<serverID>/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.
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 generate 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.
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 admin property, which specifies the administrative URL for the federated server.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default is Values: |
Example usage
The following is a sample GET request for the validate operation:
https://organization.example.com/<context>/portaladmin/federation/servers/A5jgUpHKuk8thd8R/validate?f=pjsonResponse values
The following list outlines the possible status values included in the operation's response:
successsuccess with warningsfailureundetermined
JSON Response example
{
"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"
}