DELETE Certificates/{guid}
Removes a Certificate object, all associated objects including pending workflow tickets, and the corresponding Secret Store vault information. To confirm, look in the UI. DELETE Certificates/{guid} removes the objects when the following conditions are met:
- The Certificate object when it corresponds to the GUID.
- The Application object, associated with the certificate, has no children or only Generational Credential children after the Certificate object is deleted.
- The Device object, associated with the application, when it has no children after the Application object is deleted.
Requirements
- Permissions: The caller must have either Master Admin permission, or the caller must have Delete permission to the Certificate, Application, and Device objects.
- Token scope: Certificate:Delete
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
Parameter |
Description |
---|---|
{guid} | A GUID that uniquely identifies the certificate. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}. To get the Certificate GUID, filter via GET Certificates or look in the UI. For more information, see How to find class names and attributes. |
Returns
DELETE Certificates/{guid} returns an HTTP status message and response as described in the following table. For valid requests, DELETE Certificates/{guid} returns a HTTP 200 message. An event is logged whenever a certificate is successfully deleted by this method. For invalid requests, the API call returns a HTTP 400 Bad request error and a response that includes Error details.
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 a HTTP 400 BadRequest and the following data in the message body:
|
Example: Delete a certificate
Request
DELETE https://tpp.venafi.example/vedsdk/Certificates/{3d6b61d-1c71-4603-883f-25b8c2ceecdd} Authorization:Bearer 4MyGeneratedBearerTknz==
Response
HTTP/1.1 200 OK { "Success": true }