SSH Key
SSH Keypairs
get-ssh-key
Retrieve SSH key details
GET /ssh-key/{name}Path parameters
| Name | In | Description |
|---|---|---|
name | path |
Responses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
fingerprint | string | SSH key fingerprint |
name | string | SSH 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
| Name | In | Description |
|---|---|---|
name | path |
Responses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
id | string | Operation ID |
message | string | Operation message |
reason | string | Operation failure reason Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict. |
reference | object | Related resource reference schema details |
state | string | Operation 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-keyRequest body
Content-Type: application/json
| Property | Type | Required | Description |
|---|---|---|---|
name | string | yes | SSH key name |
public-key | string | yes | Public key value |
Example
{
"name": "string",
"public-key": "string"
}Responses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
id | string | Operation ID |
message | string | Operation message |
reason | string | Operation failure reason Allowed values: incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, conflict. |
reference | object | Related resource reference schema details |
state | string | Operation 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-keyResponses
Status: 200 - 200
Content-Type: application/json
| Property | Type | Description |
|---|---|---|
ssh-keys | array[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