An SSH Key (Secure Shell Key) allows passwordless connection to an InstanceOpen in new context. An SSH Key is generated by creating an RSA key pairOpen in new context, consisting of a sensitive identification key, (aka private key) which must be stored securely, and a public key which is uploaded to the Scaleway interface.
The public key is kept in your Scaleway account and transferred to the Instance during the boot process, while the identification key is kept securely on your local computer. When connecting to the Instance via SSH, a trusted connection to the machine is established using the key pair.
List SSH keys
List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can define additional parameters for your query such as organization_id, name, project_id and disabled.
query Parameters
order_bySort order of the SSH keys.
pageRequested page number. Value must be greater or equal to 1.
page_sizeNumber of items per page. Value must be between 1 and 100.
organization_idFilter by Organization ID.
nameName of group to find.
project_idFilter by Project ID.
disabledDefines whether to include disabled SSH keys or not.
List SSH keys › Responses
List of SSH keys.
total_countTotal count of SSH keys.
Create an SSH key
Add a new SSH key to a Scaleway Project. You must specify the name, public_key and project_id.
Create an SSH key › Request Body
nameName of the SSH key. Max length is 1000.
public_keySSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000.
project_idProject the resource is attributed to.
Create an SSH key › Responses
idID of SSH key.
nameName of SSH key.
public_keyPublic key of SSH key.
fingerprintFingerprint of the SSH key.
created_atCreation date of SSH key. (RFC 3339 format)
updated_atLast update date of SSH key. (RFC 3339 format)
organization_idID of Organization linked to the SSH key.
project_idID of Project linked to the SSH key.
disabledSSH key status.
Get an SSH key
Retrieve information about a given SSH key, specified by the ssh_key_id parameter. The SSH key's full details, including id, name, public_key, and project_id are returned in the response.
path Parameters
ssh_key_idID of the SSH key.
Get an SSH key › Responses
idID of SSH key.
nameName of SSH key.
public_keyPublic key of SSH key.
fingerprintFingerprint of the SSH key.
created_atCreation date of SSH key. (RFC 3339 format)
updated_atLast update date of SSH key. (RFC 3339 format)
organization_idID of Organization linked to the SSH key.
project_idID of Project linked to the SSH key.
disabledSSH key status.
Update an SSH key
Update the parameters of an SSH key, including name and disable.
path Parameters
ssh_key_idUpdate an SSH key › Request Body
nameName of the SSH key. Max length is 1000.
disabledEnable or disable the SSH key.
Update an SSH key › Responses
idID of SSH key.
nameName of SSH key.
public_keyPublic key of SSH key.
fingerprintFingerprint of the SSH key.
created_atCreation date of SSH key. (RFC 3339 format)
updated_atLast update date of SSH key. (RFC 3339 format)
organization_idID of Organization linked to the SSH key.
project_idID of Project linked to the SSH key.
disabledSSH key status.