- URL:
- https://<root>/deleteSite
- Methods:
POST- Version Introduced:
- 10.1
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 delete operation deletes the site configuration and releases all server resources. The delete operation should be performed on development or test servers that need to be cleaned reguarly.
This is an unrecoverable operation. Use caution with this option because it deletes all services, settings, and other configurations.
This operation performs the following tasks:
-
Stops all server machines participating in the site. This in turn stops all GIS services hosted on the server machines.
-
All services and cluster configurations are deleted.
-
All server machines are unregistered from the site.
-
All server machines are unregistered from the site.
-
The configuration store is deleted.
Request parameters
| Parameter | Description |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the delete operation:
POST /<context>/admin/deleteSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson