POST RecycleBin/Empty

Removes all previously deleted items from the Recycle Bin. This inline task runs until the Recycle Bin is empty. Depending on the number of items, this call may take several hours to complete. If you want to empty the Recycle Bin as a background task, use the PurgeAll option with POST RecycleBin/PurgeTask.

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

None

Returns

Response description

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:

  • error: The reason for the error.

  • error_description: If available, additional information about how to retry the request.

Example: Permanently empty the Recycle Bin of all contents

CAUTION  After you empty the Recycle Bin, none of the items are available to restore later.

Request

POST https://tpp.venafi.example/vedsdk/RecycleBin/Empty
Authorization:Bearer 4MyGeneratedBearerTknz==
{
}

Response

HTTP/1.1 200 OK
{
   "Result":0
}