- URL:
- https://<root>/deleteSite
- Methods:
POST- Required Capability:
- Administrator
- Version Introduced:
- 12.2
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.
- All running data pipeline tasks will be stopped.
- All active data pipeline editors will be disconnected. The data pipeline items are preserved in your content.
- The configuration store is deleted.
- All server machines are unregistered from the site.
Request parameters
| Parameter | Description |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| Indicates success or failure of the delete operation. |
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=pjsonJSON Response syntax
{"status":"<success|failure>"}JSON Response example
{"status":"success"}