- URL:
- https://<root>/services/refreshAllServices
- Methods:
POST- Version Introduced:
- 12.0
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 refresh operation initiates an asynchronous job that restarts all currently deployed GIS services and returns information about the initiated refresh job. GIS services are restarted in batches of 10 to lessen the workload on the Kubernetes cluster. After the job restarts all GIS services, it verifies that the services have resumed running and reports whether any failures or errors have occurred.
This operation should only be run when many GIS services should be restarted at once, such as after unregistering a folder datastore, when removing mounted volume references, or after updating forward proxy settings, in order to restart all user-published services.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the refresh operation:
POST /<context>/admin/services/refreshAllServices HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8CisJSON Response example
The following is a sample response for the refresh operation. You can use the value returned for jobs to access the job resource and track the job's status after it's been submitted. For more information, see the Job resource documentation.
{
"jobsUrl": "https://organization.example.com/<context>/jobs/jb2442066-6a61-4620-bc7d-a6047c649e99",
"jobid": "jb2442066-6a61-4620-bc7d-a6047c649e99",
"status": "SUBMITTED"
}