- URL:
- https://<root>/orgs/<orgID>/federation/servers/<serverID>/validate
- Methods:
GET- Version Introduced:
- 10.9
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 validate operation performs a validation check against a federated server, returning its status and accessibility information. The response will also return failure messages for any failed validation checks.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL for the validate operation:
https://organization.example.com/<context>/admin/orgs/0123456789ABCDEF/federation/servers/vlQpWOiz9oEooY64/validate?f=pjsonJSON Response examples
The following is a sample success response for validate:
{
"messages": [
"ArcGIS Server administration URL 'https://organization.example.com:6443/context' is accessible.",
"Successfully validated the ArcGIS Server license.",
"ArcGIS Server 'https://organization.example.com:6443/context' version is compatible with Portal for ArcGIS."
],
"status": "success",
"serverId": "kt3o60bzVzLRNugQ"
}The following example demonstrates a success with warnings response for validate. For this sample response, the message indicates that the federated server does not have ArcGIS Data Store registered as a managed database:
{
"messages": [
"ArcGIS Server administration URL 'https://organization.example.com:6443/context' is accessible.",
"Successfully validated the ArcGIS Server license.",
"ArcGIS Server 'https://organization.example.com:6443/context' version is compatible with Portal for ArcGIS.",
"The federated server does not have an ArcGIS Data Store registered as a managed database and cannot be set as a hosting server."
],
"status": "success with warnings",
"serverId": "kt3o60bzVzLRNugQ"
}Responses may return other status types, such as failure and undetermined.