GET/v1/monitor-groups

Get all monitor groups

Returns every monitor group in the project the API key belongs to.

Request

This endpoint takes no path or query parameters. The project is resolved from the API key.

Response

Returns an array of group objects sorted by sort_order ascending. An empty project returns an empty array.

Response fields
group_idnumber
Identifier of the group, used in the update and delete endpoints and in the group_id field of a monitor
group_namestring
Name of the group
sort_ordernumber
Position of the group in the list
RequestcURL
curl https://api.hyperping.io/v1/monitor-groups \
  -H "Authorization: Bearer ${API_TOKEN}"
200 OKJSON
[
  {
    "group_id": 12,
    "group_name": "Production",
    "sort_order": 1
  },
  {
    "group_id": 13,
    "group_name": "Staging",
    "sort_order": 2
  },
  {
    "group_id": 14,
    "group_name": "Third-party APIs",
    "sort_order": 3
  }
]