Managed

Linode's Managed Settings View

get
https://api.linode.com/v4/managed/linode-settings/{linodeId}

Returns a single Linode's Managed settings.

This command can only be accessed by the unrestricted users of an account.

Path Parameters

linodeId
Required
integer

The Linode ID whose settings we are accessing.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/managed/linode-settings/123

Response Samples

{
  "id": 1234,
  "label": "linode123",
  "group": "linodes",
  "ssh": {
    "access": true,
    "user": "linode",
    "ip": "203.0.113.1",
    "port": 22
  }
}

Responses

200: The requested Linode's Managed settings.

id
integer

The ID of the Linode these Settings are for.

label
string

The label of the Linode these Settings are for.

group
string
Deprecated

The group of the Linode these Settings are for. This is for display purposes only.

ssh
object

The SSH settings for this Linode.

access
boolean

If true, Linode special forces may access this Linode over ssh to respond to Issues.

user
Nullable
string

The specific user, if any, Linode's special forces should use when accessing this Linode to respond to an issue.

The default null value corresponds to the root user.

ip
string

The IP Linode special forces should use to access this Linode when responding to an Issue.

By default, any of a Linode's IP addresses can be used for incident response access.

port
Nullable
integer

The port Linode special forces should use to access this Linode over ssh to respond to an Issue.

The default null value corresponds to port 22.

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.

Linode's Managed Settings Update

put
https://api.linode.com/v4/managed/linode-settings/{linodeId}

Updates a single Linode's Managed settings. This command can only be accessed by the unrestricted users of an account.

Path Parameters

linodeId
Required
integer

The Linode ID whose settings we are accessing.

Request Body Schema

ssh
object

The SSH settings for this Linode.

access
boolean

If true, Linode special forces may access this Linode over ssh to respond to Issues.

user
Nullable
string

The specific user, if any, Linode's special forces should use when accessing this Linode to respond to an issue.

The default null value corresponds to the root user.

ip
string

The IP Linode special forces should use to access this Linode when responding to an Issue.

By default, any of a Linode's IP addresses can be used for incident response access.

port
Nullable
integer

The port Linode special forces should use to access this Linode over ssh to respond to an Issue.

The default null value corresponds to port 22.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
      "ssh": {
        "access": true,
        "user": "linode",
        "ip": "203.0.113.1",
        "port": 22
      }
    }' \
    https://api.linode.com/v4/managed/linode-settings/123

Response Samples

{
  "id": 1234,
  "label": "linode123",
  "group": "linodes",
  "ssh": {
    "access": true,
    "user": "linode",
    "ip": "203.0.113.1",
    "port": 22
  }
}

Responses

200: Settings updated successfully.

id
integer

The ID of the Linode these Settings are for.

label
string

The label of the Linode these Settings are for.

group
string
Deprecated

The group of the Linode these Settings are for. This is for display purposes only.

ssh
object

The SSH settings for this Linode.

access
boolean

If true, Linode special forces may access this Linode over ssh to respond to Issues.

user
Nullable
string

The specific user, if any, Linode's special forces should use when accessing this Linode to respond to an issue.

The default null value corresponds to the root user.

ip
string

The IP Linode special forces should use to access this Linode when responding to an Issue.

By default, any of a Linode's IP addresses can be used for incident response access.

port
Nullable
integer

The port Linode special forces should use to access this Linode over ssh to respond to an Issue.

The default null value corresponds to port 22.

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.