SSH Keys

Get Ssh Keys

get

Get all SSH keys for a project

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

projectstringRequiredExample: proj_abc123456

Responses

200

Successful Response

application/json

fidstringRequiredExample: sshkey_abc123456

namestringRequired

projectstringRequiredExample: proj_abc123456

public_keystringRequired

created_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

requiredbooleanRequired

422

Validation Error

application/json

get/v2/ssh-keys

HTTPcURLJavaScriptPython

GET /v2/ssh-keys?project=proj_abc123456 HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create Ssh Key

post

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.

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

projectstringRequiredExample: proj_abc123456

namestringRequired

public_keystring · nullableOptional

requiredbooleanOptionalDefault: false

Responses

201

Successful Response

application/json

fidstringRequiredExample: sshkey_abc123456

namestringRequired

projectstringRequiredExample: proj_abc123456

public_keystringRequired

created_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

requiredbooleanRequired

private_keystring · nullableOptionalExample: -----BEGIN RSA PRIVATE KEY-----...

422

Validation Error

application/json

post/v2/ssh-keys

HTTPcURLJavaScriptPython

POST /v2/ssh-keys HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "project": "proj_abc123456",
  "name": "text",
  "public_key": "text",
  "required": false
}

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

Delete Ssh Key

delete

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

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ssh_key_fidstringRequiredExample: sshkey_abc123456

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/v2/ssh-keys/{ssh_key_fid}

HTTPcURLJavaScriptPython

DELETE /v2/ssh-keys/{ssh_key_fid} HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Ssh Key

patch

Update an SSH key to set it as required. Only admins can set a key as required.

Authorizations

MithrilAPIKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

ssh_key_fidstringRequiredExample: sshkey_abc123456

Body

application/json

requiredbooleanRequired

Responses

200

Successful Response

application/json

fidstringRequiredExample: sshkey_abc123456

namestringRequired

projectstringRequiredExample: proj_abc123456

public_keystringRequired

created_atstring · datetimeRequiredExample: 2024-01-01T00:00:00Z

requiredbooleanRequired

422

Validation Error

application/json

patch/v2/ssh-keys/{ssh_key_fid}

HTTPcURLJavaScriptPython

PATCH /v2/ssh-keys/{ssh_key_fid} HTTP/1.1
Host: api.mithril.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "required": true
}

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