URL:
https://<root>/deleteSite
Methods:
POST
Required Capability:
Administrator
Version Introduced:
12.2

Description

The deleteSite operation deletes the site configuration and releases all server resources. The deleteSite 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

ParameterDescription

f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails

status

Indicates success or failure of the delete operation.

Example usage

The following is a sample POST request for the deleteSite operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/deleteSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
{"status":"<success|failure>"}

JSON Response example

Use dark colors for code blocksCopy
1
{"status":"success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.