Managed

View Managed Service

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

Returns information about a single Managed Service on your Account.

Authorizations

Personal Access Token
OAuth: ( account:read_only)

Path Parameters

serviceId
Required
integer

The ID of the Managed Service to access.

Request Samples

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

Response Samples

{
  "id": 1234,
  "created": "2018-01-01T00:01:01",
  "status": "ok",
  "label": "prod-1",
  "region": "",
  "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: The requested Managed Service.

id
integer

This Service's unique ID.

created
string <date-time>

When this Managed Service was created.

status
string
Enum: "disabled""pending""ok""problem"

The current status of this Service.

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

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

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.

updated
string <date-time>

When this Managed Service was last updated.

address
string <url>

The URL at which this Service is monitored.

service_type
string
Enum: "url""tcp"

How this Service is monitored.

timeout
integer

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

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.

notes
Nullable
string

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

credentials
array of objects

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

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.

Update Managed Service

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

Updates information about a Managed Service.

Authorizations

Personal Access Token
OAuth: ( account:read_write)

Path Parameters

serviceId
Required
integer

The ID of the Managed Service to access.

Request Body Schema

address
string <url>

The URL at which this Service is monitored.

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 [a-zA-Z0-9-_ \.]{3,64}

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

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

Request Samples

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

{
  "id": 1234,
  "label": "prod-1",
  "status": "ok",
  "created": "2018-01-01T00:01:01",
  "region": "",
  "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.

id
integer

This Service's unique ID.

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

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

status
string
Enum: "disabled""pending""ok""problem"

The current status of this Service.

created
string <date-time>

When this Managed Service was created.

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.

updated
string <date-time>

When this Managed Service was last updated.

service_type
string
Enum: "url""tcp"

How this Service is monitored.

address
string <url>

The URL at which this Service is monitored.

timeout
integer

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

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.

notes
Nullable
string

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

credentials
array of objects

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

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.

Delete 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.

Authorizations

Personal Access Token
OAuth: ( account:read_write)

Path Parameters

serviceId
Required
integer

The ID of the Managed Service to access.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/managed/services/9994

Response Samples

{}

Responses

200: Service deleted successfully.

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.