SSH Key

SSH Keypairs

Read more

get-ssh-key

Retrieve SSH key details

GET /ssh-key/{name}

Path parameters

NameInDescription
namepath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
fingerprintstringSSH key fingerprint
namestringSSH key name
Example output
{
  "fingerprint": "string",
  "name": "string"
}

SDK reference for get-ssh-key: golang | Python | Java

CLI: exo api get-ssh-key

delete-ssh-key

Delete a SSH key

DELETE /ssh-key/{name}

Path parameters

NameInDescription
namepath

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
idstringOperation ID
messagestringOperation message
reasonstringOperation failure reason

Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict.
referenceobjectRelated resource reference schema details
statestringOperation status

Allowed values: failure, pending, success, timeout.
Example output
{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-ssh-key: golang | Python | Java

CLI: exo api delete-ssh-key


Other Operations

register-ssh-key

Import SSH key

POST /ssh-key

Request body

Content-Type: application/json

PropertyTypeRequiredDescription
namestringyesSSH key name
public-keystringyesPublic key value
Example
{
  "name": "string",
  "public-key": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
idstringOperation ID
messagestringOperation message
reasonstringOperation failure reason

Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict.
referenceobjectRelated resource reference schema details
statestringOperation status

Allowed values: failure, pending, success, timeout.
Example output
{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for register-ssh-key: golang | Python | Java

CLI: exo api register-ssh-key

list-ssh-keys

List SSH keys

GET /ssh-key

Responses

Status: 200 - 200

Content-Type: application/json

PropertyTypeDescription
ssh-keysarray[object]schema details
Example output
{
  "ssh-keys": [
    {
      "fingerprint": "string",
      "name": "string"
    }
  ]
}

SDK reference for list-ssh-keys: golang | Python | Java

CLI: exo api list-ssh-keys

Last updated on