SSH Keys

Create a SSH Key

Use this endpoint to add new SSH keys, especially when integrating new developers or setting up new instances that require secure access.

Use descriptive names for your keys to easily manage multiple SSH credentials.

POST/gpu-cloud/ssh-keys

Header parameters

Body

application/json

name*string

Example: "my-ssh-key"

publicKey*string

Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDHRbO3HkzPmp65PR...fAn7Jlb8b61BFh6k= cloud@sesterce"

Response

201403404

Return the created ssh key

Body

application/json

_id*string

Example: "668f9d8df664e3c028ce5de9"

user*string

Example: "668f9d8df664e3c028ce5de9"

name*string

Example: "ssh-key-name"

publicKey*string

Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDHRbO3HkzPmp65PR...fAn7Jlb8b61BFh6k= cloud@sesterce"

isDefault*boolean

Example: false

createdAt*string

Example: "2024-10-16T16:05:11.439Z"

updatedAt*string

Example: "2024-11-15T12:46:12.327Z"

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/ssh-keys', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "my-ssh-key",
      "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDHRbO3HkzPmp65PR...fAn7Jlb8b61BFh6k= cloud@sesterce"
    }),
});
const data = await response.json();

Response

201403404

{
  "_id": "668f9d8df664e3c028ce5de9",
  "user": "668f9d8df664e3c028ce5de9",
  "name": "ssh-key-name",
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDHRbO3HkzPmp65PR...fAn7Jlb8b61BFh6k= cloud@sesterce",
  "isDefault": false,
  "createdAt": "2024-10-16T16:05:11.439Z",
  "updatedAt": "2024-11-15T12:46:12.327Z"
}

Retrieve the list of SSH Keys created

Access this endpoint to manage your SSH keys, which is essential for securing access to your instances and maintaining a safe environment.

GET/gpu-cloud/ssh-keys

Header parameters

Response

200403404

Returns the list of user ssh keys

Body

application/json

_id*string

Example: "668f9d8df664e3c028ce5de9"

user*string

Example: "668f9d8df664e3c028ce5de9"

name*string

Example: "ssh-key-name"

publicKey*string

Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDHRbO3HkzPmp65PR...fAn7Jlb8b61BFh6k= cloud@sesterce"

isDefault*boolean

Example: false

createdAt*string

Example: "2024-10-16T16:05:11.439Z"

updatedAt*string

Example: "2024-11-15T12:46:12.327Z"

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/ssh-keys', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200403404

[
  {
    "_id": "668f9d8df664e3c028ce5de9",
    "user": "668f9d8df664e3c028ce5de9",
    "name": "ssh-key-name",
    "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDHRbO3HkzPmp65PR...fAn7Jlb8b61BFh6k= cloud@sesterce",
    "isDefault": false,
    "createdAt": "2024-10-16T16:05:11.439Z",
    "updatedAt": "2024-11-15T12:46:12.327Z"
  }
]

Mark a SSH Key as default

This endpoint is handy when you want to change the default SSH key for your connections, for example, during regular key rotation for security reasons.

PATCH/gpu-cloud/ssh-keys/{id}/makedefault

Path parameters

id*string

Header parameters

Response

204403404

SSH key marked as default

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/ssh-keys/{id}/makedefault', {
    method: 'PATCH',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

403404

{
  "statusCode": 403,
  "timestamp": "2023-08-08T12:34:56.789Z",
  "path": "/gpu-cloud/ssh-keys/:id/make-default",
  "message": "API key invalid"
}

Delete a SSH Key

Use this endpoint to clean up and remove obsolete or compromised SSH keys to maintain the security of your environment.

Regularly review and clean up unused SSH keys to maintain security.

DELETE/gpu-cloud/ssh-keys/{id}

Path parameters

id*string

Header parameters

Response

204403404

SSH key deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/gpu-cloud/ssh-keys/{id}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

403404

{
  "statusCode": 403,
  "timestamp": "2023-08-08T12:34:56.789Z",
  "path": "/gpu-cloud/ssh-keys/:id",
  "message": "API key invalid"
}