SSH Keys

Get Ssh Keys

Get all SSH keys for a project

get

/v2/ssh-keys

Authorizations

Query parameters

projectstringrequired

Example: proj_abc123456

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.mlfoundry.com/v2/ssh-keys?project=proj_abc123456' \
  --header 'Authorization: Bearer fkey_<key>'

200

422

200

[
  {
    "fid": "sshkey_abc123456",
    "name": "text",
    "project": "proj_abc123456",
    "public_key": "text",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Successful Response

Create Ssh Key

Create a new SSH key. If public_key is not provided, this endpoint will generate a new RSA key pair and return both the private and public keys.

post

/v2/ssh-keys

Authorizations

Body

projectstringrequired

Example: proj_abc123456

namestringrequired

public_keyany of

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.mlfoundry.com/v2/ssh-keys' \
  --header 'Authorization: Bearer fkey_<key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "project": "proj_abc123456",
    "name": "text",
    "public_key": "text"
  }'

201

422

201

{
  "fid": "sshkey_abc123456",
  "name": "text",
  "project": "proj_abc123456",
  "public_key": "text",
  "created_at": "2024-01-01T00:00:00Z",
  "private_key": "-----BEGIN RSA PRIVATE KEY-----..."
}

Successful Response

Delete Ssh Key

Delete an SSH key. Note that SSH keys used in active bids/reservations cannot be deleted.

delete

/v2/ssh-keys/{ssh_key_fid}

Authorizations

Path parameters

ssh_key_fidstringrequired

Example: sshkey_abc123456

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.mlfoundry.com/v2/ssh-keys/{ssh_key_fid}' \
  --header 'Authorization: Bearer fkey_<key>'

204

422

204

No body

Successful Response