Monitor groups

PreviousMonitor NextDestroy

Was this helpful?

List monitor groups

get

/monitor_groups

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/monitor_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "enabled": true,
      "description": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Create a monitor group

Create a new monitor group.

post

/monitor_groups

Authorizations

Body

namestring · min: 1 · max: 64

Name of monitor group

enabledboolean

Enable monitor group or not.

descriptionstring · max: 1024

Description for monitor group

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/monitor_groups' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "description": "text"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created monitor group

Retrieve a monitor group

Retrieves details of a monitor group.

get

/monitor_groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of monitor group.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/monitor_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "enabled": true,
  "description": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update an monitor group.

Update an monitor group

post

/monitor_groups/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of monitor group.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

Name of monitor group

enabledboolean

Enable monitor group or not.

descriptionstring · max: 1024

Description for monitor group

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/monitor_groups/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "description": "text"
  }'

200

4XX

No body