POST Config/Delete
Deletes a Config object from the Policy tree.
Requirements
- Permissions: The caller must have Delete permission to the requested object. Certificates and devices require additional API calls.
- Token scope: Configuration: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
Name |
Description |
---|---|
ObjectDN |
The Distinguished Name (DN) of the object to delete. |
Recursive (Optional) |
When set to 1, the subordinate objects delete as well. If you are deleting a policy folder that contains objects, such as certificates that the Secret Store, avoid this parameter. |
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: Delete a device
This example assumes that POST SecretStore/OwnerDelete already removed all vault records prior to the Config/Delete call.
Request
POST https://tpp.venafi.example/vedsdk/Config/Delete Authorization:Bearer 4MyGeneratedBearerTknz== { "ObjectDN":"\\VED\\Policy\\Testdevice" }
Response
HTTP/1.1 200 OK { "Result":1 }