SSH keys

Update SSH keys

This method updates a name of an existing SSH-key. You can only update an SSH key created by the current Service application that you use to send a request. You can't update SSH keys created by other users and applications.

put/v1/ssh-keys/{sshKeyId}

Request

Base URL
https://api.emma.ms/external
Auth
HTTP bearer

Path parameters

sshKeyIdinteger required

SSH key ID

Request body

namestring required

SSH key name

Example request

{
  "name": "mykey"
}

Response

Successful operation

idinteger

SSH key ID

namestring

SSH key name

keystring

SSH public key

fingerprintstring

SSH key fingerprint

keyTypestring

SSH key type (RSA or ED25519)

createdAtstring

Date and time when the SSH key was created

createdByNamestring

Name of the user who created the SSH key

createdByIdinteger

ID of the user who created the SSH key

Example response

{
  "id": 60,
  "name": "mykey",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDMwmR5qB5VU9X4VYQJjXDT3qketmrrqEABSNAEEkfTtOtIZrKJmMST9bEus/5FFm9b5w5unyZaW39PUe/QDrxwB8Y3b+DTyA1LcRzd2UhCQsybh9DKbDb+HX0lKrgIeUkadwIq5gE2nx3VBQUifa2BGYC7b+FtFLjtHaOwWIvuQC7AYozCB+B69P3q8tK0D9UXlLyGGsBe8MYjl0mV9IumWS7WBz2VDqLhAvFIzpcERVstepLM9Y4mePpDhfQqt85MRIrqTWikhZExwbRmbSFCZHPi85Os2oxSHoXH1NMSBNEt3yJB4Cn5f2nBV45ysd0HcQmn7eLmRPzbkmhfYoOL Lego%20Group@localhost",
  "fingerprint": "f2:60:34:c8:34:b2:a3:da:22:f9:12:f9:03:f0:33:c0",
  "keyType": "RSA",
  "createdAt": "2021-11-26T14:54:11",
  "createdByName": "Automation User",
  "createdById": 123
}

Changes

No recorded changes to this operation across all 1 revision of this API.