POST RecycleBin/GetConfiguration

Returns Deletion Process and the Purge Process rules for managing data. The Deletion Process moves old data into the Recycle Bin. The Purge Process empties the Recycle Bin. Both processes automatically run nightly tasks. To run a task without waiting, you can call POST RecycleBin/DeletionTask or 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

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Deletion: Rules about how a Deletion task moves items into the Recycle Bin:

    • AllottedTime: The maximum number of minutes, NOT hours, that the Deletion task can run. The default is 180 minutes. VCC setting: Limit deletion process runtime to shows the value in hours.
    • Tasks:  An array of enabled Deletion Tasks and settings. Each task appears in a VCC tab of the Recycle Bin. Disabled tasks are omitted.

    • QuerySize: The number of items to remove each time tasks run via POST RecycleBin/DeletionTask or the Deletion Process. For example, the Deletion Process automatically moves this number of old items into the Recycle Bin each night until the task criteria is met. VCC setting: Delete a maximum of [n] entries per task.

    • SqlTimeout: Only change this value when Customer Support recommends a different setting. The maximum number of seconds the Deletion Task can query the Trust Protection Platform database. The default is 600 seconds. The minimum is 15 seconds.

  • Purge: The configuration for the automatic Purge Process and Purge Task. To control permanent removal of items from the Recycle Bin, these settings also appear in VCC: 

    Purge settings

    • After: The number of days to retain items before they are permanently removed from the Recycle Bin. VCC setting:  Purge items deleted more than [n] days ago.

    • AllottedTime: The maximum number of minutes, NOT hours, that the Purge task can run. The default is 180 minutes. VCC setting: Limit purge process runtime to [n] hours.

    • EngineDN: The Distinguished Name (DN) of the ToDo engine that processes purge tasks. VCC setting:  Engine to run purge process.

  • 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: Show deletion and purge rules

Request

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

Response

HTTP/1.1 200 OK
{
   "Deletion":{
      "AllottedTime":180,
      "QuerySize":1000,
      "SqlTimeout":600,
      "Tasks":[
         "CertificateAge|3650|1",
         "CertificateHistory|5"
      ]
   },
   "Purge":{
      "After":14,
      "AllottedTime":180
   },
   "Result":0
}