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
Name |
Description |
---|---|
HTTP 200 |
For valid requests, this call returns a HTTP 200 message and the following data in the message body:
|
HTTP 400 |
For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:
|
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 }