DestroyProject

This method can be used for the following: Destroy project(s) data. WARNING: This is irreversible

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

DELETE /api/ss/project/destroy HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Body

project_ids (array of strings)

Project Ids for projects to be destroyed.

Example:

{
    "project_ids": [ "689ad06ba798a64475353712" ]
}

keep_logs (boolean) (optional)

Keep project log files. Logs are removed (false) by default.

Example:

{
    "keep_logs": true
}

Example

The following example is a cURL request to destroy a project.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X DELETE 'https://localhost:3000/api/ss/project/destroy' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
   "project_ids": [ "689ad06ba798a64475353712" ],
   "keep_logs": true
}'

Response

Response contains a status.

{
   "status": "ok"
}

Last updated