SSH Management APIs
The SSH Management APIs allow to manage device keys and keysets. This interface is valid only if you purchased SSH Protect.
All product-supported operations are exposed via this API, including key operations (addition, removal, and editing of keys), rotation and methods to get the actual state of data. For more information about the SSH objects, see the Web SDK Object class reference.
📄️ Returns connection status for provided devices
_Required scope: Any_
📄️ Imports key usage from a Unix or Linux host syslog.
_Required scope: Any_
📄️ Finds all key usage records matching the specified filtering criteria.
_Required scope: Any_
📄️ Marks a key for deletion.
_Required scope: Any_
📄️ Cancels any running key operation. Can also rollback a key to its original state.
_Required scope: Any_
📄️ Retries any failing operation (addition, removal, editing) on specified key.
_Required scope: Any_
📄️ Starts Synchronous Rotation of a specific keyset.
_Required scope: Any_
📄️ Submits Rotation request of specific keyset.
_Required scope: Any_
📄️ Submits Rollback request of specific keyset.
_Required scope: Any_
📄️ 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.
_Required scope: Any_
📄️ Retries rotation of specified keyset.
_Required scope: Any_
📄️ Changes Source Restrictions, and Forced commands in an authorized keys file.
_Required scope: Any_
📄️ Changes location, notes, Source Restrictions, and Forced commands in an selfservice authorized keys.
_Required scope: Any_
📄️ Assigns an existing keyset to a policy folder.
_Required scope: Any_
📄️ Add an authorization key to a keyset.
_Required scope: Any_
📄️ Verifies that a user manually installed a private key.
_Required scope: Any_
📄️ Moves a list of keysets to a policy folder.
_Required scope: Any_
📄️ Downloads an authorized key.
_Required scope: Any_
📄️ Downloads a private key.
_Required scope: Any_
📄️ Skip key rotation.
_Required scope: Any_
📄️ Installs a new user private key on a device.
_Required scope: Any_
📄️ Creates and installs a new private key on a host device.
_Required scope: Any_
📄️ Creates an Open SSH Authorized key for provisioning to a device.
_Required scope: Any_
📄️ Creates a public key for a host.
_Required scope: Any_
📄️ Adds or reuses a Base64 public key for a device.
_Required scope: Any_
📄️ Adds or reuses a Base64 private key for a device.
_Required scope: Any_
📄️ Changes the private key passphrase for a keyset.
_Required scope: Any_
📄️ Sets the passphrase on a keyset that is missing the encrypted private key.
_Required scope: Any_
📄️ Deletes an unmatched keyset that is missing the encrypted private key passphrase and .pub file extension.
_Required scope: Any_
📄️ Returns detailed key data.
_Required scope: Any_
📄️ Finds devices in the Policy tree that match the filtering criteria.
_Required scope: Any_
📄️ Provides information about every device that shares the same keyset.
_Required scope: Any_
📄️ Returns private and public key pairs that identify details about a device
_Required scope: Any_
📄️ Approves any key operation that has a Pending Approval status in a workflow.
_Required scope: Any_
📄️ Rejects any key operation that has a Pending Approval status in a workflow.
_Required scope: Any_