POST RecycleBin/GetContents
Lists deleted items that are in the Recycle Bin. The Recycle Bin appears in VCC or in the VCC snap in. You can use this endpoint to discover items in the Recycle Bin and determine whether an item and its children are restorable via POST RecycleBin/Restore. Based on the RestoreState, recovery may be possible.
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
Name |
Description |
---|---|
Limit |
(Optional) The maximum number of entries to return in the response. If the value is 0, the response only contains Total and Result. |
Returns
TIP Remember that the Recycle Bin retains deleted items based on the current Purge Process settings.
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 Recycle Bin items
Request
POST https://tpp.venafi.example/vedsdk/RecycleBin/GetContents Authorization:Bearer 4MyGeneratedBearerTknz== { "Limit": "50" }
Response
HTTP/1.1 200 OK { "Items":[ { "ChildCount":4, "DN":"\\VED\\Policy\\certificates_data\\cred_msca", "DeletedBy":{ "FullName":"\\VED\\Identity\\admin", "Name":"admin", "Prefix":"local", "PrefixedName":"local:admin", "PrefixedUniversal":"local:{7492e6c1-9f96-4927-8ea0-1a720aa28380}", "Type":1, "Universal":"{7492e6c1-9f96-4927-8ea0-1a720aa28380}" }, "DeletedOn":"05/27/2022 20:21:51", "Guid":"82f8d7c9-1ece-4a8c-bf3a-2821f3fb7f2d", "Name":"cred_msca", "PurgeOn":"08/25/2022 20:21:51", "RestorationDN":"\\VED\\Policy\\certificates_data\\cred_msca", "RestoreState":1, "Type":"Config Object", "TypeDetail":"Username Password Credential" }, { "DN":"\\VED\\Policy\\test4\\delete4", "DeletedBy":{ "Prefix":"Internal", "PrefixedName":"Internal:", "PrefixedUniversal":"Internal:CertificateAge", "Universal":"CertificateAge" }, "DeletedOn":"06\/02\/2022", "Guid":"1b837de7-121b-4756-aced-ba1112f4286a", "Name":"CA_templ_StandardSSL(1year)", "PurgeOn":"08/25/2022 20:22:09", "RestorationDN":"\\VED\\Policy\\certificates_data\\CA_templ_StandardSSL(1year)", "RestoreState":1, "Type":"Config Object", "TypeDetail":"Microsoft CA" }, { "DN":"\\VED\\Discovery\\MyCAImportDiscoveryJob", "DeletedBy":{ "FullName":"\\VED\\Identity\\admin", "Name":"admin", "Prefix":"local", "PrefixedName":"local:admin", "PrefixedUniversal":"local:{7492e6c1-9f96-4927-8ea0-1a720aa28380}", "Type":1, "Universal":"{7492e6c1-9f96-4927-8ea0-1a720aa28380}" }, "DeletedOn":"05/27/2022 20:25:05", "Guid":"7fbf844b-024a-411f-b6bc-1e320832a107", "Name":"MyCAImportDiscoveryJob", "PurgeOn":"08/25/2022 20:25:05", "RestorationDN":"\\VED\\Discovery\\MyCAImportDiscoveryJob", "RestoreState":1, "Type":"Config Object", "TypeDetail":"CA Import" }, { "DN":"\\VED\\Logging\\Notification Rules\\LogNotficationHeartBeat", "DeletedBy":{ "FullName":"\\VED\\Identity\\admin", "Name":"admin", "Prefix":"local", "PrefixedName":"local:admin", "PrefixedUniversal":"local:{7492e6c1-9f96-4927-8ea0-1a720aa28380}", "Type":1, "Universal":"{7492e6c1-9f96-4927-8ea0-1a720aa28380}" }, "DeletedOn":"05/27/2022 20:26:46", "Guid":"8ac7fc18-db93-4efd-8c96-9d97df14304b", "Name":"LogNotficationHeartBeat", "PurgeOn":"08/25/2022 20:26:46", "RestorationDN":"\\VED\\Logging\\Notification Rules\\LogNotficationHeartBeat", "RestoreState":1, "Type":"Config Object", "TypeDetail":"Log Heartbeat" } ], "Result":0, "Total":4 }