Access requirements
Required privileges
The ArcGIS 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 ArcGIS 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 ArcGIS Portal Directory API. For security reasons, all POST requests made to the ArcGIS Enterprise Administrator API must include a token in the request body.
Description
The config resource returns a list of resource types that correspond with the Overview page of ArcGIS Enterprise Manager. Each JSON object contains the default update property for each resource type that specifies the interval (in minutes) when information, such as health and status updates, for each type will be pulled and cached. Resource types that have an update interval of 0 won't have their information cached and instead return information in real time when the overview resource is called by ArcGIS Enterprise Manager. The default values for update can be modified through the Update operation. The cached and real-time information for each resource can be viewed by calling the Overview resource.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the config resource page:
https://organization.example.com/<context>/admin/overview/config?f=pjsonJSON Response example
{
"configs": [
{
"updateIntervalMin": 0,
"id": "d52fe0a1-c853-4a71-a870-aaf86033474e",
"type": "criticalLogs"
},
{
"updateIntervalMin": 1,
"id": "d9269ba4-d6df-444f-934c-1c5ed9c2f629",
"type": "systemServices"
},
{
"updateIntervalMin": 1,
"id": "0173c590-78d3-4372-af87-952a8fe42739",
"type": "utilityServices"
},
{
"updateIntervalMin": 1,
"id": "9a575de7-90de-45d6-b3b3-61d9640d65d7",
"type": "dataStores"
}
]
}