- URL:
- https://<root>/overview/update/config
- Methods:
POST- Version Introduced:
- 10.9
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 operation can be used to modify the update property for an overview resource type. The update property determines the interval (in minutes) when information, such as health and status information, for each overview resource type is pulled and cached. If the update frequency is specified as 0, no information is collected and cached for that resource type. Instead, when the Overview resource is manually called from the ArcGIS Enterprise Administrator API, or automatically by the ArcGIS Enterprise Manager, the real-time information for the resource type is returned.
Request parameters
| Parameter | Details |
|---|---|
(Required) | A JSON array containing the overview resource type JSON objects. The JSON objects must contain the
Example |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/admin/overview/update/config HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
resourceConfigJson={
"configs": [
{
"updateIntervalMin": 2,
"id": "1af0fa98-2ac2-44fe-be1c-0f9f75a8ef77",
"type": "criticalLogs"
},
{
"updateIntervalMin": 1,
"id": "9595eece-5d9b-408b-911f-93d080896ac5",
"type": "systemServices"
},
{
"updateIntervalMin": 1,
"id": "04c99764-0698-4586-badd-40ec9dc87a92",
"type": "utilityServices"
},
{
"updateIntervalMin": 1,
"id": "0c12a861-f29b-48ef-b515-36497b041830",
"type":"dataStores"
}
]
}&f=pjson&token=vGSqTwWwUv558RgvF1JzOM6dMJ4IXYR4sD9wwOBjHOppvvQp9Czd6S57c170S_T696AQOmfhK0NEn0wGhIUtHpaYFStDijj4yXmGgBbe6mj1zAm3oi0Up9pVLmH2V1rfAytc764RxOsx_BHwEEWQOBEn4kT0O3xkcpMDeOQaFlcphQ2XnBAot9r1riiWMFRenH-Rf1Mu0RSJuC9D5-LgnOSnkvC04K0Jy49ui-YSlqTL0i97Dw2SLtGtNoXUvVXQJSON Response example
{"status": "success"}