Managed
v4.83.1 GET
https://api.linode.com/v4/managed/contacts
Returns a paginated list of Managed Contacts on your Account.
personalAccessToken oauth account:read_only
page Type: integer
>= 1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..100Default:
100
Default: 100 The number of items to return per page.
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed contacts-list
200
default
{
"data" : [
{
"email" : "john.doe@example.org" ,
"group" : "on-call" ,
"id" : 567 ,
"name" : "John Doe" ,
"phone" : {
"primary" : "123-456-7890" ,
"secondary" : null
},
"updated" : "2018-01-01T00:01:01"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
200
default
A paginated list of ManagedContacts
array of objects
string <email>
The address to email this Contact to alert them of issues.
string
2..50
characters
A grouping for this Contact. This is for display purposes only.
integer
This Contact’s unique ID.
string
2..64
characters
The name of this Contact.
object
Information about how to reach this Contact by phone.
string <phone>
This Contact’s primary phone number.
string <phone>
This Contact’s secondary phone number.
string <date-time>
When this Contact was last updated.
integer
integer
integer
Error
array of objects
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.
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.
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.
personalAccessToken oauth account:read_write
Request Body Schema string <email>
The address to email this Contact to alert them of issues.
string
2..50
characters
A grouping for this Contact. This is for display purposes only.
string
2..64
characters
The name of this Contact.
object
Information about how to reach this Contact by phone.
string <phone>
This Contact’s primary phone number.
string <phone>
This Contact’s secondary phone number.
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"name": "John Doe",
"email": "john.doe@example.org",
"phone": {
"primary": "123-456-7890",
"secondary": null
},
"group": "on-call"
}' \
linode-cli managed contact-create \
"John Doe" \
"john.doe@example.org" \
"123-456-7890"
200
default
{
"email" : "john.doe@example.org" ,
"group" : "on-call" ,
"id" : 567 ,
"name" : "John Doe" ,
"phone" : {
"primary" : "123-456-7890" ,
"secondary" : null
},
"updated" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
200
default
Contact created.
string <email>
The address to email this Contact to alert them of issues.
string
2..50
characters
A grouping for this Contact. This is for display purposes only.
integer
This Contact’s unique ID.
string
2..64
characters
The name of this Contact.
object
Information about how to reach this Contact by phone.
string <phone>
This Contact’s primary phone number.
string <phone>
This Contact’s secondary phone number.
string <date-time>
When this Contact was last updated.
Error
array of objects
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.
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.
DELETE
https://api.linode.com/v4/managed/contacts/{contactId}
Deletes a Managed Contact.
personalAccessToken oauth account:read_write
contactId integer
Required The ID of the contact to access.
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli managed contact-delete 567
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
200
default
Contact deleted successfully.
Error
array of objects
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.
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.
GET
https://api.linode.com/v4/managed/contacts/{contactId}
Returns a single Managed Contact.
personalAccessToken oauth account:read_write
contactId integer
Required The ID of the contact to access.
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed contact-view 567
200
default
{
"email" : "john.doe@example.org" ,
"group" : "on-call" ,
"id" : 567 ,
"name" : "John Doe" ,
"phone" : {
"primary" : "123-456-7890" ,
"secondary" : null
},
"updated" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
200
default
The requested Managed Contact.
string <email>
The address to email this Contact to alert them of issues.
string
2..50
characters
A grouping for this Contact. This is for display purposes only.
integer
This Contact’s unique ID.
string
2..64
characters
The name of this Contact.
object
Information about how to reach this Contact by phone.
string <phone>
This Contact’s primary phone number.
string <phone>
This Contact’s secondary phone number.
string <date-time>
When this Contact was last updated.
Error
array of objects
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.
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.
PUT
https://api.linode.com/v4/managed/contacts/{contactId}
Updates information about a Managed Contact.
personalAccessToken oauth account:read_write
contactId integer
Required The ID of the contact to access.
Request Body Schema string <email>
The address to email this Contact to alert them of issues.
string
2..50
characters
A grouping for this Contact. This is for display purposes only.
string
2..64
characters
The name of this Contact.
object
Information about how to reach this Contact by phone.
string <phone>
This Contact’s primary phone number.
string <phone>
This Contact’s secondary phone number.
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"name": "John Doe",
"email": "john.doe@example.org",
"phone": {
"primary": "123-456-7890",
"secondary": null
},
"group": "on-call"
}' \
linode-cli managed contact-update 567 \
"John Doe" \
"john.doe@example.org" \
"123-456-7890"
200
default
{
"email" : "john.doe@example.org" ,
"group" : "on-call" ,
"id" : 567 ,
"name" : "John Doe" ,
"phone" : {
"primary" : "123-456-7890" ,
"secondary" : null
},
"updated" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
200
default
Contact updated successfully.
string <email>
The address to email this Contact to alert them of issues.
string
2..50
characters
A grouping for this Contact. This is for display purposes only.
integer
This Contact’s unique ID.
string
2..64
characters
The name of this Contact.
object
Information about how to reach this Contact by phone.
string <phone>
This Contact’s primary phone number.
string <phone>
This Contact’s secondary phone number.
string <date-time>
When this Contact was last updated.
Error
array of objects
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.
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.
Managed Credentials List GET
https://api.linode.com/v4/managed/credentials
Returns a paginated list of Managed Credentials on your Account.
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>= 1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..100Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed credentials-list
Response Samples
200
default
{
"data" : [
{
"id" : 9991 ,
"label" : "prod-password-1" ,
"last_decrypted" : "2018-01-01T00:01:01"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of ManagedCredentials
array of objects
integer
This Credential’s unique ID.
string
2..75
characters
The unique label for this Credential. This is for display purposes only.
string <date-time>
The date this Credential was last decrypted by a member of Linode special forces.
integer
integer
integer
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_write
Request Body Schema string
2..75
characters
The unique label for this Credential. This is for display purposes only.
string
The password to use when accessing the Managed Service.
string
<= 5000
characters
The username to use when accessing the Managed Service.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"label": "prod-password-1",
"username": "johndoe",
"password": "s3cur3P@ssw0rd"
}' \
linode-cli managed credential-create \
\
\
Response Samples
200
default
{
"id" : 9991 ,
"label" : "prod-password-1" ,
"last_decrypted" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Credential created.
integer
This Credential’s unique ID.
string
2..75
characters
The unique label for this Credential. This is for display purposes only.
string <date-time>
The date this Credential was last decrypted by a member of Linode special forces.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_only
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed credential-sshkey-view
Response Samples
200
default
{
"ssh_key" : "ssh-rsa AAAAB...oD2ZQ== managedservices@linode"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested Managed SSH public key.
string
The unique SSH public key assigned to your Linode account’s Managed service.
Error
array of objects
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.
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.
Managed Credential View GET
https://api.linode.com/v4/managed/credentials/{credentialId}
Returns a single Managed Credential.
Authorizations personalAccessToken oauth account:read_write
Path Parameters credentialId integer
Required The ID of the Credential to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed credential-view 9991
Response Samples
200
default
{
"id" : 9991 ,
"label" : "prod-password-1" ,
"last_decrypted" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested Managed Credential.
integer
This Credential’s unique ID.
string
2..75
characters
The unique label for this Credential. This is for display purposes only.
string <date-time>
The date this Credential was last decrypted by a member of Linode special forces.
Error
array of objects
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.
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.
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 Update Managed Credential Username and Password (
POST /managed/credentials/{credentialId}/update ) endpoint instead.
Authorizations personalAccessToken oauth account:read_write
Path Parameters credentialId integer
Required The ID of the Credential to access.
Request Body Schema string
2..75
characters
The unique label for this Credential. This is for display purposes only.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"label": "prod-password-1"
}' \
linode-cli managed credential-update 9991 \
Response Samples
200
default
{
"id" : 9991 ,
"label" : "prod-password-1" ,
"last_decrypted" : "2018-01-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Credential updated successfully.
integer
This Credential’s unique ID.
string
2..75
characters
The unique label for this Credential. This is for display purposes only.
string <date-time>
The date this Credential was last decrypted by a member of Linode special forces.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_write
Path Parameters credentialId integer
Required The ID of the Credential to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli managed credential-revoke 9991
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Credential deleted successfully.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_write
Path Parameters credentialId integer
Required The ID of the Credential to update.
Request Body Schema string
The password to use when accessing the Managed Service.
string
<= 5000
characters
The username to use when accessing the Managed Service.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"username": "johndoe",
"password": "s3cur3P@ssw0rd"
}' \
linode-cli managed credential-update-username-password 9991 \
\
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Credential username and password updated.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>= 1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..100Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed issues-list
Response Samples
200
default
{
"data" : [
{
"created" : "2018-01-01T00:01:01" ,
"entity" : {
"id" : 98765 ,
"label" : "Managed Issue opened!" ,
"type" : "ticket" ,
"url" : "/support/tickets/98765"
},
"id" : 823 ,
"services" : [
null
]
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of open or ongoing Managed Issues.
array of objects
string <date-time>
When this Issue was created. Issues are created in response to issues detected with Managed Services, so this is also when the Issue was detected.
object
The ticket this Managed Issue opened.
integer
This ticket’s ID
string
The summary for this Ticket.
stringEnum:
ticket
The type of entity this is. In this case, it is always a Ticket.
string <url>
The relative URL where you can access this Ticket.
integer
This Issue’s unique ID.
array of integers
An array of Managed Service IDs that were affected by this Issue.
integer
integer
integer
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_only
Path Parameters issueId integer
Required The Issue to look up.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed issue-view 823
Response Samples
200
default
{
"created" : "2018-01-01T00:01:01" ,
"entity" : {
"id" : 98765 ,
"label" : "Managed Issue opened!" ,
"type" : "ticket" ,
"url" : "/support/tickets/98765"
},
"id" : 823 ,
"services" : [
null
]
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested issue.
string <date-time>
When this Issue was created. Issues are created in response to issues detected with Managed Services, so this is also when the Issue was detected.
object
The ticket this Managed Issue opened.
integer
This ticket’s ID
string
The summary for this Ticket.
stringEnum:
ticket
The type of entity this is. In this case, it is always a Ticket.
string <url>
The relative URL where you can access this Ticket.
integer
This Issue’s unique ID.
array of integers
An array of Managed Service IDs that were affected by this Issue.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_only
Query Parameters page Type: integer
>= 1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..100Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed linode-settings-list
Response Samples
200
default
{
"data" : [
{
"group" : "linodes" ,
"id" : 123 ,
"label" : "linode123" ,
"ssh" : {
"access" : true ,
"ip" : "12.34.56.78" ,
"port" : 22 ,
"user" : "linode"
}
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of Managed settings for your Linodes.
array of objects
string
The group of the Linode these Settings are for. This is for display purposes only.
integer
The ID of the Linode these Settings are for.
string
The label of the Linode these Settings are for.
object
The SSH settings for this Linode.
boolean
If true, Linode special forces may access this Linode over ssh to respond to Issues.
string <ip>
The IP Linode special forces should use to access this Linode when responding to an Issue.
integer
1..65535
The port Linode special forces should use to access this Linode over ssh to respond to an Issue.
string
<= 32
characters
The user Linode’s special forces should use when accessing this Linode to respond to an issue.
integer
integer
integer
Error
array of objects
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.
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.
Linode's Managed Settings View GET
https://api.linode.com/v4/managed/linode-settings/{linodeId}
Returns a single Linode’s Managed settings.
Authorizations personalAccessToken oauth account:read_only
Path Parameters linodeId integer
Required The Linode ID whose settings we are accessing.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed linode-setting-view 123
Response Samples
200
default
{
"group" : "linodes" ,
"id" : 123 ,
"label" : "linode123" ,
"ssh" : {
"access" : true ,
"ip" : "12.34.56.78" ,
"port" : 22 ,
"user" : "linode"
}
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested Linode's Managed settings.
string
The group of the Linode these Settings are for. This is for display purposes only.
integer
The ID of the Linode these Settings are for.
string
The label of the Linode these Settings are for.
object
The SSH settings for this Linode.
boolean
If true, Linode special forces may access this Linode over ssh to respond to Issues.
string <ip>
The IP Linode special forces should use to access this Linode when responding to an Issue.
integer
1..65535
The port Linode special forces should use to access this Linode over ssh to respond to an Issue.
string
<= 32
characters
The user Linode’s special forces should use when accessing this Linode to respond to an issue.
Error
array of objects
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.
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.
Linode's Managed Settings Update PUT
https://api.linode.com/v4/managed/linode-settings/{linodeId}
Updates a single Linode’s Managed settings.
Authorizations personalAccessToken oauth account:read_write
Path Parameters linodeId integer
Required The Linode ID whose settings we are accessing.
Request Body Schema object
The SSH settings for this Linode.
boolean
If true, Linode special forces may access this Linode over ssh to respond to Issues.
string <ip>
The IP Linode special forces should use to access this Linode when responding to an Issue.
integer
1..65535
The port Linode special forces should use to access this Linode over ssh to respond to an Issue.
string
<= 32
characters
The user Linode’s special forces should use when accessing this Linode to respond to an issue.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"ssh": {
"access": true,
"user": "linode",
"ip": "12.34.56.78",
"port": 22
}
}' \
linode-cli managed linode-setting-update \
7833234 \
true \
\
22 \
Response Samples
200
default
{
"group" : "linodes" ,
"id" : 123 ,
"label" : "linode123" ,
"ssh" : {
"access" : true ,
"ip" : "12.34.56.78" ,
"port" : 22 ,
"user" : "linode"
}
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Settings updated successfully.
string
The group of the Linode these Settings are for. This is for display purposes only.
integer
The ID of the Linode these Settings are for.
string
The label of the Linode these Settings are for.
object
The SSH settings for this Linode.
boolean
If true, Linode special forces may access this Linode over ssh to respond to Issues.
string <ip>
The IP Linode special forces should use to access this Linode when responding to an Issue.
integer
1..65535
The port Linode special forces should use to access this Linode over ssh to respond to an Issue.
string
<= 32
characters
The user Linode’s special forces should use when accessing this Linode to respond to an issue.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_only
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed services-list
Response Samples
200
default
{
"data" : [
{
"address" : "https://example.org" ,
"body" : "it worked" ,
"consultation_group" : "on-call" ,
"created" : "2018-01-01T00:01:01" ,
"credentials" : [
null
],
"id" : 9944 ,
"label" : "prod-1" ,
"notes" : "The service name is my-cool-application" ,
"region" : null ,
"service_type" : "url" ,
"status" : "ok" ,
"timeout" : 30 ,
"updated" : "2018-03-01T00:01:01"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of Managed Services
array of objects
string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
string <date-time>
When this Managed Service was created.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
integer
This Service’s unique ID.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
stringEnum:
disabled
pending
ok
problem
The current status of this Service.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
string <date-time>
When this Managed Service was last updated.
integer
integer
integer
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_write
Request Body Schema string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"service_type": "url",
"label": "prod-1",
"address": "https://example.org",
"timeout": 30,
"body": "it worked",
"consultation_group": "on-call",
"notes": "The service name is my-cool-application",
"credentials": [
9991
]
}' \
linode-cli managed service-create \
\
\
"https://example.org" \
30 \
"it worked" \
\
"The service name is \
my-cool-application" \
9991
Response Samples
200
default
{
"address" : "https://example.org" ,
"body" : "it worked" ,
"consultation_group" : "on-call" ,
"created" : "2018-01-01T00:01:01" ,
"credentials" : [
null
],
"id" : 9944 ,
"label" : "prod-1" ,
"notes" : "The service name is my-cool-application" ,
"region" : null ,
"service_type" : "url" ,
"status" : "ok" ,
"timeout" : 30 ,
"updated" : "2018-03-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service created.
string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
string <date-time>
When this Managed Service was created.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
integer
This Service’s unique ID.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
stringEnum:
disabled
pending
ok
problem
The current status of this Service.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
string <date-time>
When this Managed Service was last updated.
Error
array of objects
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.
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.
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.
Authorizations personalAccessToken oauth account:read_write
Path Parameters serviceId integer
Required The ID of the Managed Service to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli managed service-delete 9994
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service deleted successfully.
Error
array of objects
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.
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.
Managed Service View GET
https://api.linode.com/v4/managed/services/{serviceId}
Returns information about a single Managed Service on your Account.
Authorizations personalAccessToken oauth account:read_only
Path Parameters serviceId integer
Required The ID of the Managed Service to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed service-view 9994
Response Samples
200
default
{
"address" : "https://example.org" ,
"body" : "it worked" ,
"consultation_group" : "on-call" ,
"created" : "2018-01-01T00:01:01" ,
"credentials" : [
null
],
"id" : 9944 ,
"label" : "prod-1" ,
"notes" : "The service name is my-cool-application" ,
"region" : null ,
"service_type" : "url" ,
"status" : "ok" ,
"timeout" : 30 ,
"updated" : "2018-03-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
The requested Managed Service.
string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
string <date-time>
When this Managed Service was created.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
integer
This Service’s unique ID.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
stringEnum:
disabled
pending
ok
problem
The current status of this Service.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
string <date-time>
When this Managed Service was last updated.
Error
array of objects
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.
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.
Managed Service Update PUT
https://api.linode.com/v4/managed/services/{serviceId}
Updates information about a Managed Service.
Authorizations personalAccessToken oauth account:read_write
Path Parameters serviceId integer
Required The ID of the Managed Service to access.
Request Body Schema string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"service_type": "url",
"label": "prod-1",
"address": "https://example.org",
"timeout": 30,
"body": "it worked",
"consultation_group": "on-call",
"notes": "The service name is my-cool-application",
"credentials": [
9991
]
}' \
linode-cli managed service-update 9994 \
\
\
"https://example.org" \
30 \
"it worked" \
\
"The service name is my-cool-application" \
9991
Response Samples
200
default
{
"address" : "https://example.org" ,
"body" : "it worked" ,
"consultation_group" : "on-call" ,
"created" : "2018-01-01T00:01:01" ,
"credentials" : [
null
],
"id" : 9944 ,
"label" : "prod-1" ,
"notes" : "The service name is my-cool-application" ,
"region" : null ,
"service_type" : "url" ,
"status" : "ok" ,
"timeout" : 30 ,
"updated" : "2018-03-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service updated successfully.
string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
string <date-time>
When this Managed Service was created.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
integer
This Service’s unique ID.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
stringEnum:
disabled
pending
ok
problem
The current status of this Service.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
string <date-time>
When this Managed Service was last updated.
Error
array of objects
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.
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.
Managed Service Disable POST
https://api.linode.com/v4/managed/services/{serviceId}/disable
Temporarily disables monitoring of a Managed Service.
Authorizations personalAccessToken oauth account:read_write
Path Parameters serviceId integer
Required The ID of the Managed Service to disable.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
\
linode-cli managed service-disable 9994
Response Samples
200
default
{
"address" : "https://example.org" ,
"body" : "it worked" ,
"consultation_group" : "on-call" ,
"created" : "2018-01-01T00:01:01" ,
"credentials" : [
null
],
"id" : 9944 ,
"label" : "prod-1" ,
"notes" : "The service name is my-cool-application" ,
"region" : null ,
"service_type" : "url" ,
"status" : "ok" ,
"timeout" : 30 ,
"updated" : "2018-03-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service disabled.
string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
string <date-time>
When this Managed Service was created.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
integer
This Service’s unique ID.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
stringEnum:
disabled
pending
ok
problem
The current status of this Service.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
string <date-time>
When this Managed Service was last updated.
Error
array of objects
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.
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.
Managed Service Enable POST
https://api.linode.com/v4/managed/services/{serviceId}/enable
Enables monitoring of a Managed Service.
Authorizations personalAccessToken oauth account:read_write
Path Parameters serviceId integer
Required The ID of the Managed Service to enable.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
\
linode-cli managed service-enable 9994
Response Samples
200
default
{
"address" : "https://example.org" ,
"body" : "it worked" ,
"consultation_group" : "on-call" ,
"created" : "2018-01-01T00:01:01" ,
"credentials" : [
null
],
"id" : 9944 ,
"label" : "prod-1" ,
"notes" : "The service name is my-cool-application" ,
"region" : null ,
"service_type" : "url" ,
"status" : "ok" ,
"timeout" : 30 ,
"updated" : "2018-03-01T00:01:01"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Service enabled.
string <url>
3..
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.
string
<= 100
characters
What to expect to find in the response body for the Service to be considered up.
string
<= 50
characters
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
string <date-time>
When this Managed Service was created.
array of integers
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
integer
This Service’s unique ID.
string
3..64
characters
The label for this Service. This is for display purposes only.
string
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
string
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
stringEnum:
url
tcp
How this Service is monitored.
stringEnum:
disabled
pending
ok
problem
The current status of this Service.
integer
1..255
How long to wait, in seconds, for a response before considering the Service to be down.
string <date-time>
When this Managed Service was last updated.
Error
array of objects
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.
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.
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 Authorizations personalAccessToken oauth account:read_only
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli managed stats-list
Response Samples
200
default
{
"data" : {
"cpu" : [
{
"true" : 29.94 ,
"x" : 11513761600000
}
],
"disk" : [
{
"true" : 29.94 ,
"x" : 11513761600000
}
],
"net_in" : [
{
"true" : 29.94 ,
"x" : 11513761600000
}
],
"net_out" : [
{
"true" : 29.94 ,
"x" : 11513761600000
}
],
"swap" : [
{
"true" : 29.94 ,
"x" : 11513761600000
}
]
}
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A list of Managed Stats from the last 24 hours.
StatsDataAvailable
StatsDataUnavailable
object
A collection of graph data returned for managed stats.
array of objects
CPU usage stats from the last 24 hours.
integer
A stats graph data point.
integer
A stats graph data point.
array of objects
Disk usage stats from the last 24 hours.
integer
A stats graph data point.
integer
A stats graph data point.
array of objects
Inbound network traffic stats from the last 24 hours.
integer
A stats graph data point.
integer
A stats graph data point.
array of objects
Outbound network traffic stats from the last 24 hours.
integer
A stats graph data point.
integer
A stats graph data point.
array of objects
Swap usage stats from the last 24 hours.
integer
A stats graph data point.
integer
A stats graph data point.
array of strings
An array of error messages if managed stats are unavaliable.
Error
array of objects
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.
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.
