POST RecycleBin/Purge

Permanently removes an item from the Recycle Bin. If you want to automatically remove some items and retain others, call POST RecycleBin/SetConfiguration. Then, either wait for the nightly purge or immediately purge via 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

Input parameters

Name

Description

Guid

The GUID of the Recycle Bin Item to delete. Use the Guid format from POST RecycleBin/GetContents. For example, 3d6b61d-1c71-4603-883f-25b8c2ceecdd.

Returns

Response description

Name

Description

HTTP 200

Result: The reason for success or failure. For more information, see Recycle Bin result codes.

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 remove a previously deleted item and its children

CAUTION  After you purge an item from the Recycle Bin, the item is no longer available to restore at a later time.

Request

POST https://tpp.venafi.example/vedsdk/RecycleBin/Purge
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Guid": "1f03ccf4-0c1c-4391-b6da-925597e46846"
}

Response

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