Managed
Managed Service View
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.
Path Parameters
The ID of the Managed Service to access.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/managed/services/9994
Response Samples
- 200
- default
{
"status": "ok",
"created": "2018-01-01T00:01:01",
"updated": "2018-03-01T00:01:01",
"id": 1234,
"label": "prod-1",
"region": "",
"address": "https://example.org",
"service_type": "url",
"timeout": 30,
"body": "it worked",
"consultation_group": "on-call",
"notes": "The service name is my-cool-application",
"credentials": []
}Responses
200: The requested Managed Service.
The current status of this Service.
When this Managed Service was created.
When this Managed Service was last updated.
This Service's unique ID.
The label for this Service. This is for display purposes only.
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
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.
How this Service is monitored.
How long to wait, in seconds, for a response before considering the Service to be down.
What to expect to find in the response body for the Service to be considered up.
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
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.
Managed Service Update
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.
Path Parameters
The ID of the Managed Service to access.
Request Body Schema
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.
What to expect to find in the response body for the Service to be considered up.
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
The label for this Service. This is for display purposes only.
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
How this Service is monitored.
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" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"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
]
}' \
https://api.linode.com/v4/managed/services/9994
Response Samples
- 200
- default
{
"id": 1234,
"label": "prod-1",
"status": "ok",
"region": "",
"created": "2018-01-01T00:01:01",
"updated": "2018-03-01T00:01:01",
"address": "https://example.org",
"service_type": "url",
"timeout": 30,
"body": "it worked",
"consultation_group": "on-call",
"notes": "The service name is my-cool-application",
"credentials": []
}Responses
200: Service updated successfully.
This Service's unique ID.
The label for this Service. This is for display purposes only.
The current status of this Service.
When this Managed Service was created.
When this Managed Service was last updated.
The Region in which this Service is located. This is required if address is a private IP, and may not be set otherwise.
How this Service is monitored.
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.
How long to wait, in seconds, for a response before considering the Service to be down.
What to expect to find in the response body for the Service to be considered up.
The group of ManagedContacts who should be notified or consulted with when an Issue is detected.
Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.
An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.
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.
Managed Service 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.
Path Parameters
The ID of the Managed Service to access.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/managed/services/9994
Response Samples
- 200
- default
{}Responses
200: Service 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.