attach ssh-key

Attaches an SSH key to the specified instance, allowing SSH access using the provided key.

CLI Usage: vastai attach ssh <instance_id> <ssh_key>

POST /api/v0/instances/{id}/ssh

attach ssh-key

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/instances/{id}/ssh/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAA..."
}
'

200

{
  "success": true,
  "msg": "SSH key attached successfully"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

id · integer · required

ID of the instance to attach the SSH key to

Body

application/json

ssh_key · string

The SSH key to attach to the instance

Minimum string length: 1

Example:

"ssh-rsa AAAAB3NzaC1yc2EAAA..."

Response

200

application/json

SSH key attached successfully

success · boolean

Example:

true

msg · string

Example:

"SSH key attached successfully"