POST SSH/CancelRotation

Cancels rotation of the specified keyset if it is running, or rolls back the keyset to the previous version if the rotation has finished or failed. If cancel or rollback are not possible, the method 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

KeysetId

The identifier of a set of public and private key pairs. Depending on your environment, the value may be expressed with or without curly braces {}. You can get the KeysetId, from POST SSH/KeyUsage or the SSH Keyset Inventory. For example:

Location of KeysetID in the UI

Returns

Response description

Name

Description

Response

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

Example Cancel Keyset Rotation

Request

POST https://tpp.venafi.example/vedsdk/SSH/CancelRotation 
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "KeysetId":"70AF05FAB7910CD923EB98B003110930F68D5EC6"
}

Response

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