POST SSH/CancelKeyOperation

Cancels any running key operation. Can also rollback a key to its original state.

If you cancel a key addition, this API call removes corresponding key from the Trust Protection Platform database because the key does not exist on a remote device. If no operation is running or failing for the key, CancelKeyOperation does nothing.

Requirements

  • Token scope:  SSH:Manage

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 cancel an addition, edit, or removal operation.

Returns

Response description

Name

Description

Response

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

Example cancel a Keyset operation

Request

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

Response

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