API/v1/monitor-groups

Monitor Groups API

Monitor groups organise monitors into named sections. Use these endpoints to list, create, rename, reorder, and delete groups, then attach a monitor to a group with the group_id field on the Monitors API.

ℹ️Base URL

https://api.hyperping.io

Authentication

All requests require your project API key in the Authorization header:

Header

Authorization: Bearer $USER_API_KEY

Groups are scoped to the project the key belongs to. Reading groups works with a read-only key. Creating, updating, and deleting a group requires a key with write permissions, otherwise the request returns 403.

The group object

A group has three fields:

Attributes

group_idnumber

Numeric identifier of the group. Use it in the path of the update and delete endpoints, and in the group_id field when creating or updating a monitor.

group_namestring

Name shown above the monitors in the group. Names are unique within a project.

sort_ordernumber

Position of the group in the list. Groups are returned in ascending order.