NEnetxms
SSH Keys

Create SSH key

Changed on

Create a new SSH key. If only a name is provided, a new RSA key pair is generated. If publicKey and privateKey fields are also provided, the key pair is imported.

post/v1/ssh-keys

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/ssh-keys
  • Auth
    HTTP bearer

Request body

namestring required

SSH key name

publicKeystring

Public key to import (omit to generate a new key pair)

privateKeystring

Private key to import (required if publicKey is provided)

Response

SSH key created successfully

idinteger

SSH key ID

namestring

SSH key name

publicKeystring

Public key in OpenSSH format (included in details and when includePublicKey=true)

Changes