Managed v4.174.0

Managed Contacts List

GET https://api.linode.com/v4/managed/contacts

Returns a paginated list of Managed Contacts on your Account.

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

Authorizations

personalAccessToken
oauth	account:read_only

Query Parameters

page

Type:: [integer] >= 1
Default: 1
Default:: 1

The page of a collection to return.

page_size

Type:: [integer] 25..500
Default: 100
Default:: 100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed Contact Create

POST https://api.linode.com/v4/managed/contacts

Creates a Managed Contact. A Managed Contact is someone Linode special forces can contact in the course of attempting to resolve an issue with a Managed Service.

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

Authorizations

personalAccessToken
oauth	account:read_write

Request Samples

Request Body Schema

[string]<email>

The address to email this Contact to alert them of issues.

group

Nullable

[string] 2..50 characters

A grouping for this Contact. This is for display purposes only.

name

[string] 2..64 characters

The name of this Contact.

phone

[object]

Information about how to reach this Contact by phone.

primary Nullable	`[string]<phone>` This Contact’s primary phone number.
secondary Nullable	`[string]<phone>` This Contact’s secondary phone number.

Response Samples

Responses

Managed Contact Delete

DELETE https://api.linode.com/v4/managed/contacts/{contactId}

Deletes a Managed Contact.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

contactId

[integer]

Required

The ID of the contact to access.

Request Samples

Response Samples

Responses

Managed Contact View

GET https://api.linode.com/v4/managed/contacts/{contactId}

Returns a single Managed Contact.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

contactId

[integer]

Required

The ID of the contact to access.

Request Samples

Response Samples

Responses

Managed Contact Update

PUT https://api.linode.com/v4/managed/contacts/{contactId}

Updates information about a Managed Contact. This command can only be accessed by the unrestricted users of an account.

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

contactId

[integer]

Required

The ID of the contact to access.

Request Samples

Request Body Schema

[string]<email>

The address to email this Contact to alert them of issues.

group

Nullable

[string] 2..50 characters

A grouping for this Contact. This is for display purposes only.

name

[string] 2..64 characters

The name of this Contact.

phone

[object]

Information about how to reach this Contact by phone.

primary Nullable	`[string]<phone>` This Contact’s primary phone number.
secondary Nullable	`[string]<phone>` This Contact’s secondary phone number.

Response Samples

Responses

Managed Credentials List

GET https://api.linode.com/v4/managed/credentials

Returns a paginated list of Managed Credentials on your Account.

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

Authorizations

personalAccessToken
oauth	account:read_only

Query Parameters

page

Type:: [integer] >= 1
Default: 1
Default:: 1

The page of a collection to return.

page_size

Type:: [integer] 25..500
Default: 100
Default:: 100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed Credential Create

POST https://api.linode.com/v4/managed/credentials

Creates a Managed Credential. A Managed Credential is stored securely to allow Linode special forces to access your Managed Services and resolve issues.

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

Authorizations

personalAccessToken
oauth	account:read_write

Request Samples

Request Body Schema

label Required	`[string]` 2..75 characters The unique label for this Credential. This is for display purposes only.
password Required	`[string]` The password to use when accessing the Managed Service.
username	`[string]` <= 5000 characters The username to use when accessing the Managed Service.

Response Samples

Responses

Managed SSH Key View

GET https://api.linode.com/v4/managed/credentials/sshkey

Returns the unique SSH public key assigned to your Linode account’s Managed service. If you add this public key to a Linode on your account, Linode special forces will be able to log in to the Linode with this key when attempting to resolve issues.

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

Authorizations

personalAccessToken
oauth	account:read_only

Request Samples

Response Samples

Responses

Managed Credential View

GET https://api.linode.com/v4/managed/credentials/{credentialId}

Returns a single Managed Credential.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

credentialId

[integer]

Required

The ID of the Credential to access.

Request Samples

Response Samples

Responses

Managed Credential Update

PUT https://api.linode.com/v4/managed/credentials/{credentialId}

Updates the label of a Managed Credential. This endpoint does not update the username and password for a Managed Credential. To do this, use the Managed Credential Username and Password Update ( POST /managed/credentials/{credentialId}/update) endpoint instead. This command can only be accessed by the unrestricted users of an account.

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

credentialId

[integer]

Required

The ID of the Credential to access.

Request Samples

Request Body Schema

label

[string] 2..75 characters

The unique label for this Credential. This is for display purposes only.

Response Samples

Responses

Managed Credential Delete

POST https://api.linode.com/v4/managed/credentials/{credentialId}/revoke

Deletes a Managed Credential. Linode special forces will no longer have access to this Credential when attempting to resolve issues.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

credentialId

[integer]

Required

The ID of the Credential to access.

Request Samples

Response Samples

Responses

Managed Credential Username and Password Update

POST https://api.linode.com/v4/managed/credentials/{credentialId}/update

Updates the username and password for a Managed Credential.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

credentialId

[integer]

Required

The ID of the Credential to update.

Request Samples

Request Body Schema

password Required	`[string]` The password to use when accessing the Managed Service.
username	`[string]` <= 5000 characters The username to use when accessing the Managed Service.

Response Samples

Responses

Managed Issues List

GET https://api.linode.com/v4/managed/issues

Returns a paginated list of recent and ongoing issues detected on your Managed Services.

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

Authorizations

personalAccessToken
oauth	account:read_only

Query Parameters

page

Type:: [integer] >= 1
Default: 1
Default:: 1

The page of a collection to return.

page_size

Type:: [integer] 25..500
Default: 100
Default:: 100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed Issue View

GET https://api.linode.com/v4/managed/issues/{issueId}

Returns a single Issue that is impacting or did impact one of your Managed Services.

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

Authorizations

personalAccessToken
oauth	account:read_only

Path Parameters

issueId

[integer]

Required

The Issue to look up.

Request Samples

Response Samples

Responses

Managed Linode Settings List

GET https://api.linode.com/v4/managed/linode-settings

Returns a paginated list of Managed Settings for your Linodes. There will be one entry per Linode on your Account.

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

Authorizations

personalAccessToken
oauth	account:read_only

Query Parameters

page

Type:: [integer] >= 1
Default: 1
Default:: 1

The page of a collection to return.

page_size

Type:: [integer] 25..500
Default: 100
Default:: 100

The number of items to return per page.

Request Samples

Response Samples

Responses

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.

Authorizations

personalAccessToken
oauth	account:read_only

Path Parameters

linodeId

[integer]

Required

The Linode ID whose settings we are accessing.

Request Samples

Response Samples

Responses

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.

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

linodeId

[integer]

Required

The Linode ID whose settings we are accessing.

Request Samples

Request Body Schema

ssh

[object]

The SSH settings for this Linode.

access	`[boolean]` Default: `true` If true, Linode special forces may access this Linode over ssh to respond to Issues.
ip	`[string]<ip>` Default: `any` 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]` 1..65535 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.
user Nullable	`[string]` <= 32 characters 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.

Response Samples

Responses

Managed Services List

GET https://api.linode.com/v4/managed/services

Returns a paginated list of Managed Services on your Account. These are the services Linode Managed is monitoring and will report and attempt to resolve issues with.

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

Authorizations

personalAccessToken
oauth	account:read_only

Request Samples

Response Samples

Responses

Managed Service Create

POST https://api.linode.com/v4/managed/services

Creates a Managed Service. Linode Managed will begin monitoring this service and reporting and attempting to resolve any Issues.

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

Authorizations

personalAccessToken
oauth	account:read_write

Request Samples

Request Body Schema

address Required	`[string]<url>` 3..100 characters The URL at which this Service is monitored. URL parameters such as `?no-cache=1` are preserved. URL fragments/anchors such as `#monitor` are not preserved.
body Nullable	`[string]` <= 100 characters What to expect to find in the response body for the Service to be considered up.
consultation_group	`[string]` <= 50 characters The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
credentials	`[array]` An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
label Required	`[string]` 3..64 characters The label for this Service. This is for display purposes only.
notes Nullable	`[string]` Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
region	`[string]` The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
service_type Required	`[string]` Enum: `url` `tcp` How this Service is monitored.
timeout Required	`[integer]` 1..255 How long to wait, in seconds, for a response before considering the Service to be down.

Response Samples

Responses

Managed Service Delete

DELETE https://api.linode.com/v4/managed/services/{serviceId}

Deletes a Managed Service. This service will no longer be monitored by Linode Managed.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

serviceId

[integer]

Required

The ID of the Managed Service to access.

Request Samples

Response Samples

Responses

Managed Service View

GET https://api.linode.com/v4/managed/services/{serviceId}

Returns information about a single Managed Service on your Account.

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

Authorizations

personalAccessToken
oauth	account:read_only

Path Parameters

serviceId

[integer]

Required

The ID of the Managed Service to access.

Request Samples

Response Samples

Responses

Managed Service Update

PUT https://api.linode.com/v4/managed/services/{serviceId}

Updates information about a Managed Service.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

serviceId

[integer]

Required

The ID of the Managed Service to access.

Request Samples

Request Body Schema

address	`[string]<url>` 3..100 characters The URL at which this Service is monitored. URL parameters such as `?no-cache=1` are preserved. URL fragments/anchors such as `#monitor` are not preserved.
body Nullable	`[string]` <= 100 characters What to expect to find in the response body for the Service to be considered up.
consultation_group	`[string]` <= 50 characters The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
credentials	`[array]` An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
label	`[string]` 3..64 characters The label for this Service. This is for display purposes only.
notes Nullable	`[string]` Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
region	`[string]` The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
service_type	`[string]` Enum: `url` `tcp` How this Service is monitored.
timeout	`[integer]` 1..255 How long to wait, in seconds, for a response before considering the Service to be down.

Response Samples

Responses

Managed Service Disable

POST https://api.linode.com/v4/managed/services/{serviceId}/disable

Temporarily disables monitoring of a Managed Service.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

serviceId

[integer]

Required

The ID of the Managed Service to disable.

Request Samples

Response Samples

Responses

Managed Service Enable

POST https://api.linode.com/v4/managed/services/{serviceId}/enable

Enables monitoring of a Managed Service.

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

Authorizations

personalAccessToken
oauth	account:read_write

Path Parameters

serviceId

[integer]

Required

The ID of the Managed Service to enable.

Request Samples

Response Samples

Responses

Managed Stats List

GET https://api.linode.com/v4/managed/stats

Returns a list of Managed Stats on your Account in the form of x and y data points. You can use these data points to plot your own graph visualizations. These stats reflect the last 24 hours of combined usage across all managed Linodes on your account giving you a high-level snapshot of data for the following:

cpu
disk
swap
network in
network out

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

Authorizations

personalAccessToken
oauth	account:read_only

Search Results

No Results

Filters

Managed v4.174.0

Managed Contacts List

Authorizations

Query Parameters

Request Samples

Response Samples

Responses

Managed Contact Create

Authorizations

Request Samples

Request Body Schema

Response Samples

Responses

Managed Contact Delete

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed Contact View

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed Contact Update

Authorizations

Path Parameters

Request Samples

Request Body Schema

Response Samples

Responses

Managed Credentials List

Authorizations

Query Parameters

Request Samples

Response Samples

Responses

Managed Credential Create

Authorizations

Request Samples

Request Body Schema

Response Samples

Responses

Managed SSH Key View

Authorizations

Request Samples

Response Samples

Responses

Managed Credential View

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed Credential Update

Authorizations

Path Parameters

Request Samples

Request Body Schema

Response Samples

Responses

Managed Credential Delete

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed Credential Username and Password Update

Authorizations

Path Parameters

Request Samples

Request Body Schema

Response Samples

Responses

Managed Issues List

Authorizations