Update a managed service monitor

put

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

Updates a service monitor's configuration settings.

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

Permissions and scopes

To call this operation, you need the following:

OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: account:read_write

CLI

linode-cli managed service-update 9994 \
  --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

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

serviceId

integer

required

The ID of the Managed Service to access.

Body Params

A service that Linode is monitoring as part of your Managed services. If issues are detected with this service, a ManagedIssue will be opened and, optionally, Linode special forces will attempt to resolve the Issue.

address

url

length between 3 and 100

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

string | null

What to expect to find in the response body for the Service to be considered up.

consultation_group

string

length between 0 and 50

The group of ManagedContacts who should be notified or consulted with when an Issue is detected.

credentials

array of integers

An array of ManagedCredential IDs that should be used when attempting to resolve issues with this Service.

credentials

label

string

length between 3 and 64

[a-zA-Z0-9-_ \.]{3,64}

The label for this Service. This is for display purposes only.

notes

string | null

Any information relevant to the Service that Linode special forces should know when attempting to resolve Issues.

region

string | null

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

How this Service is monitored, either url or tcp.

Allowed:

timeout

integer

1 to 255

How long to wait, in seconds, for a response before considering the Service to be down.

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/json

200Service updated successfully.

defaultSee Errors for the range of possible error response codes.