POST RecycleBin/DeletionTask
Starts or stops Deletion Tasks that automatically move older objects and vault entries into the Recycle Bin. You can enable or disable Deletion tasks in VCC. The purge time is based on settings in VCC or POST RecycleBin/SetConfiguration. However, you may still be able to recover automatically or manually purged items.
Requirements
- Permissions: The caller must have Master Admin permission
- Token scope: Admin:RecycleBin
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
Specify one parameter NOT both.
Name |
Description |
---|---|
Start |
(Optional) 1: Instead of waiting for the nightly Deletion Process, start Deletion Tasks now. Allow Deletion Tasks to move items into the Recycle Bin. Only move items that meet criteria in the configured tasks. Upon completion, log a 'Deletion Complete' event. |
Stop |
(Optional)1: Halt the Deletion Tasks that is already running. |
Returns
Name |
Description |
---|---|
HTTP 200 |
Result: 0: |
HTTP 400 |
For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:
|
Example: Stop Deletion Tasks that are currently running
Request
POST https://tpp.venafi.example/vedsdk/RecycleBin/DeletionTask Authorization:Bearer 4MyGeneratedBearerTknz== { "Stop": 1 }
Response
HTTP/1.1 200 OK { "Result": 0 }