NVnvidia
SSH Key

Create SSH Key

Changed on

Create an SSH Key for the current Tenant. If an SSH Key Group is specified, all Sites associated with the SSH Key Group must be online.

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix.

post/v2/org/{org}/nico/sshkey

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/sshkey
  • Auth
    HTTP bearer

Request body

namestring required

Name cannot match that name an existing SSH Key

publicKeystring required

Must be an SSH key of type: RSA, ECDSA or ED25519

sshKeyGroupIdstring uuid nullable

ID of the SSH Key Group this key should be attached to

Example request

{
  "name": "sre-ssh-reno",
  "publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAICip4hl6WjuVHs60PeikVUs0sWE/kPhk2D0rRHWsIuyL jdoe@test.com",
  "sshKeyGroupId": "0b5be54a-65ee-4a85-9928-90e6bca22dac"
}

Response

Created

idstring uuid

Unique identifier for the key

namestring

Name of the SSHKey

orgstring

Organization the SSHKey belongs to

tenantIdstring uuid

ID of the Tenant

fingerprintstring

SHA256 fingerprint of the public key

createdstring date-time

Date/time when the SSH key was created

updatedstring date-time

Date/time when the SSH key was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "sre-ssh-reno",
  "org": "wdksahew1rqf",
  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "fingerprint": "CaK2yoj5fDOhf1swM2kFyjQrd3bwZfDYlWnVjBHgveQ",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status