- URL:
- https://<root>/system/directories/recover
- Methods:
POST- Version Introduced:
- 10.4
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Server Administrator API must include a token in the request body.
Description
The recover operation can be used to recover a site if the shared server directories are permanently lost. If the shared server directories for a site are unavailable, a site in read-only mode will operate in a degraded capacity that allows access to the ArcGIS Server Administrator Directory. To perform this operation, the site must be in read-only mode and the site configuration files must have been copied to the local repository when switching site modes. The recover operation will copy the server directories from the local repository into the shared server directories location. The copied local repository will be from the machine in the site where the recover operation is performed.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the recover operation:
POST /<context>/admin/system/directories/recover HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON Response example
{"status": "success"}