POST Platform/Delete
Removes a Trust Protection Platform engine from the system. Use this API call as part of the process of decommissioning a server.
Requirements
- Permissions: The caller must have Delete permission to the Engine object.
- 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 |
---|---|
Platform |
The engine name. To get the value, go to the Platforms tree or call GET ProcessingEngines. |
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 a HTTP 400 BadRequest: Error: The reason for failure. |
Example: Delete a temporary instance of Trust Protection Platform
Request for Example
POST https://tpp.venafi.example/vedsdk/Platform/Delete
Authorization:Bearer 4MyGeneratedBearerTknz==
{ "Platform":"ec-fbe2e6a31c17" }
Response for Example
HTTP/1.1 200 OK { "Error":null, "Success":true }