Monitor groups

List monitor groups

List monitor groups

GEThttp://127.0.0.1:8888/api/monitor_groups

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/monitor_groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a monitor group

Create a new monitor group.

POSThttp://127.0.0.1:8888/api/monitor_groups

Body

application/json

namestring

Name of monitor group

enabledboolean

Enable monitor group or not.

descriptionstring

Description for monitor group

Response

2014XX

Created monitor group

Body

application/json

idall of

The unique ID of monitor group.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/monitor_groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a monitor group

Retrieves details of a monitor group.

GEThttp://127.0.0.1:8888/api/monitor_groups/{id}

Path parameters

id*all of

The unique ID of monitor group.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of monitor group.

namestring

Name of monitor group

enabledboolean

Enable monitor group or not.

descriptionstring

Description for monitor group

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/monitor_groups/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "enabled": false,
  "description": "text"
}

Update an monitor group.

Update an monitor group

POSThttp://127.0.0.1:8888/api/monitor_groups/{id}

Path parameters

id*all of

The unique ID of monitor group.

Body

application/json

namestring

Name of monitor group

enabledboolean

Enable monitor group or not.

descriptionstring

Description for monitor group

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/monitor_groups/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();