POST SSH/RemoveKey

Marks a key for deletion. However, the device can still use the key until deletion actually occurs. The amount of time that the key remains valid depends the work remediation schedule in the UI. For more information, see Setting up SSH remediation work.

Requirements

  • Token scope:  SSH: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

Input parameters

Name

Description

KeyId

Identifier of key to remove.

Returns

Response description

Name

Description

Response

SshWebResponse object with result of the operation. For more information, see SSH SshWebResponse object.

Example: Remove a key

Request

POST https://tpp.venafi.example/vedsdk/SSH/RemoveKey 
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "KeyId" : 59
}

Response

HTTP/1.1 200 OK
{
   "Success":true
}