Profile
SSH Key View
https://api.linode.com/v4/profile/sshkeys/{sshKeyId}
Returns a single SSH Key object identified by id
that you have access to view.
Path Parameters
The ID of the SSHKey
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/profile/sshkeys/42
Response Samples
- 200
- default
{
"created": "2018-01-01T00:01:01",
"id": 1234,
"label": "My SSH Key",
"ssh_key": "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"
}
Responses
200: An SSH Key object
The date this key was added.
The unique identifier of an SSH Key object.
A label for the SSH Key.
The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.
Accepted formats:
- ssh-dss
- ssh-rsa
- ecdsa-sha2-nistp
- ssh-ed25519
- sk-ecdsa-sha2-nistp256 (Akamai-specific)
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
SSH Key Update
https://api.linode.com/v4/profile/sshkeys/{sshKeyId}
Updates an SSH Key that you have permission to read_write
.
Only SSH key labels can be updated.
Path Parameters
The ID of the SSHKey
Request Body Schema
A label for the SSH Key.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"label": "my laptop"
}' \
https://api.linode.com/v4/profile/sshkeys/42
Response Samples
- 200
- default
{
"id": 1234,
"label": "My SSH Key",
"created": "2018-01-01T00:01:01",
"ssh_key": "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"
}
Responses
200: SSH Key updated successfully.
A label for the SSH Key.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
SSH Key Delete
https://api.linode.com/v4/profile/sshkeys/{sshKeyId}
Deletes an SSH Key you have access to.
Note: deleting an SSH Key will not remove it from any Linode or Disk that was deployed with authorized_keys
. In those cases, the keys must be manually deleted on the Linode or Disk. This endpoint will only delete the key's association from your Profile.
Path Parameters
The ID of the SSHKey
Request Samples
- Shell
- CLI
curl -H "Authoriztion: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/profile/sshkeys/42
Response Samples
- 200
- default
{}
Responses
200: SSH Key deleted successfully.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.