Profile

List SSH Keys

get
https://api.linode.com/v4/profile/sshkeys

Returns a collection of SSH Keys you've added to your Profile.

Authorizations

Personal Access Token
OAuth: ( account:read_only)

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 100]
Default: 100

The number of items to return per page.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/profile/sshkeys

Response Samples

{
  "data": [
    {
      "id": "",
      "created": "2018-01-01T00:01:01",
      "label": "My SSH Key",
      "ssh_key": ""
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: Returns a paginated list of SSH Key objects.

data
array of objects
id
integer

The unique identifier of an SSH Key object.

created
string

The date this key was added.

label
string

A label for the SSH Key.

ssh_key
string

The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

page
integer
pages
integer
results
integer

default: Error

errors
array of objects
reason
string

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.

field
string

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.

Add SSH Key

post
https://api.linode.com/v4/profile/sshkeys

Adds an SSH Key to your Account profile.

Authorizations

Personal Access Token
OAuth: ( account:read_write)

Request Body Schema

label
string [1 .. 64] characters

A label for the key.

ssh_key
string <ssh-key>

The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
        "label": "My SSH Key"
        "ssh_key": "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"
    }' \
    https://api.linode.com/v4/profile/sshkeys

Response Samples

{
  "id": 1234,
  "label": "My SSH Key",
  "created": "2018-01-01T00:01:01",
  "ssh_key": ""
}

Responses

200: SSH Key associated successfully.

id
integer

The unique identifier of an SSH Key object.

label
string <= 64 characters

A label for the SSH Key.

created
string <date-time>

The date this key was added.

ssh_key
string <ssh-key>

The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

default: Error

errors
array of objects
reason
string

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.

field
string

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.