Checks & alerts

The monitoring checks that apply to devices, per-device exclusions and direct assignments, and the alerts they raise: list, acknowledge and resolve.

MethodPathSummary
GET/v2/app/rmm-checks/checksList monitoring checks
GET/v2/app/rmm-checks/checks/:idGet a single check with its actions and assignments
POST/v2/app/rmm-checks/checksCreate a monitoring check
PUT/v2/app/rmm-checks/checks/:idUpdate a check. Requires an active RMM license
POST/v2/app/rmm-checks/checks/:id/toggleToggle a check's enabled/disabled state
DELETE/v2/app/rmm-checks/checks/:idDelete a check. Requires an active RMM license
GET/v2/app/rmm-checks/device/:deviceId/checksList checks that apply to a device
POST/v2/app/rmm-checks/device/:deviceId/exclude/:checkIdToggle exclusion of a check for a specific device
POST/v2/app/rmm-checks/device/:deviceId/assign/:checkIdAssign an existing check directly to a device
GET/v2/app/rmm-checks/alertsList recent alert log entries
POST/v2/app/rmm-checks/alerts/:id/resolveManually resolve (dismiss) a firing alert
POST/v2/app/rmm-checks/alerts/acknowledgeAcknowledge firing alerts
GET/v2/app/rmm-checks/alerts/activeList currently firing alerts

#List monitoring checks

GET/v2/app/rmm-checks/checks

List monitoring checks. Requires an active RMM license. Returns every check configured for the tenant, each annotated with its action count, assignment count, and number of currently firing alerts.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Response 200

FieldTypeDescription
checksarray of any
Example response
JSON
{
  "checks": []
}

Errors

StatusMessage
404User not found

Example request

Bash
curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Get a single check with its actions and assignments

GET/v2/app/rmm-checks/checks/:id

Get a single check with its actions and assignments. Requires an active RMM license. Returns the check row plus its notification actions and its site/group/device scope assignments (with resolved site/group/device names where applicable).

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
idrequiredinteger

Response 200

FieldTypeDescription
checkany
actionsarray of any
assignmentsarray of any
Example response
JSON
{
  "check": null,
  "actions": [],
  "assignments": []
}

Errors

StatusMessage
404User not found
404Check not found

Example request

Bash
curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/42' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Create a monitoring check

POST/v2/app/rmm-checks/checks

Create a monitoring check. Requires an active RMM license. Creates the check row, then any provided notification actions and scope assignments in the same request.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Request body JSON

NameTypeDescription
namerequiredstring
descriptionstring
check_typerequiredstring
check_configrequiredany
severityany
actionsarray of any
assignmentsarray of any

Response 201

FieldTypeDescription
messagestring
check_idinteger
Example response
JSON
{
  "message": "Saved",
  "check_id": 7
}

Errors

StatusMessage
400name, check_type and check_config are required
400Unknown action_type
404User not found

Example request

Bash
curl -X POST 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","description":"string","check_type":"string","check_config":"…","severity":"…","actions":[],"assignments":[]}'

#Update a check. Requires an active RMM license

PUT/v2/app/rmm-checks/checks/:id

Update a check. Requires an active RMM license. Updates the check's fields, and if actions or assignments arrays are provided, fully replaces the existing rows for that check (delete-then-reinsert).

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
idrequiredinteger

Request body JSON

NameTypeDescription
namestring
descriptionstring
check_typestring
check_configany
severityany
actionsarray of any
assignmentsarray of any

Response 200

FieldTypeDescription
messagestring
Example response
JSON
{
  "message": "Saved"
}

Errors

StatusMessage
400Unknown action_type
404User not found
404Check not found

Example request

Bash
curl -X PUT 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/42' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example name","description":"string","check_type":"string","check_config":"…","severity":"…","actions":[],"assignments":[]}'

#Toggle a check's enabled/disabled state

POST/v2/app/rmm-checks/checks/:id/toggle

Toggle a check's enabled/disabled state. Requires an active RMM license. Flips is_enabled in place (SQL NOT is_enabled) — does not report whether the resulting state is enabled or disabled.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id/toggle
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
idrequiredinteger

Response 200

FieldTypeDescription
messagestring
Example response
JSON
{
  "message": "Saved"
}

Errors

StatusMessage
404User not found

Example request

Bash
curl -X POST 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/42/toggle' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Delete a check. Requires an active RMM license

DELETE/v2/app/rmm-checks/checks/:id

Delete a check. Requires an active RMM license. Also deletes any rmm_probe_results rows for this check first, since that table has no FK back to rmm_checks. Actions and assignments cascade via FK ON DELETE CASCADE.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/:id
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
idrequiredinteger

Response 200

FieldTypeDescription
messagestring
Example response
JSON
{
  "message": "Saved"
}

Errors

StatusMessage
404User not found

Example request

Bash
curl -X DELETE 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/checks/42' \
  -H "X-API-Key: $BRAMBLE_KEY"

#List checks that apply to a device

GET/v2/app/rmm-checks/device/:deviceId/checks

List checks that apply to a device. Requires an active RMM license. Resolves checks assigned directly to the device, to its group, or to its site, and annotates each with whether it's excluded for this device (rmm_check_exclusions) and whether it currently has a firing alert for this device.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/:deviceId/checks
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
deviceIdrequiredinteger

Response 200

FieldTypeDescription
checksarray of any
Example response
JSON
{
  "checks": []
}

Errors

StatusMessage
404User not found
404Device not found

Example request

Bash
curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/1/checks' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Toggle exclusion of a check for a specific device

POST/v2/app/rmm-checks/device/:deviceId/exclude/:checkId

Toggle exclusion of a check for a specific device. Requires an active RMM license. Pauses (or un-pauses) evaluation of a check for this one device only, without touching the check's broader site/group/device assignments.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/:deviceId/exclude/:checkId
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
deviceIdrequiredinteger
checkIdrequiredinteger

Response 200

FieldTypeDescription
excludedboolean
Example response
JSON
{
  "excluded": false
}

Errors

StatusMessage
404User not found

Example request

Bash
curl -X POST 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/1/exclude/1' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Assign an existing check directly to a device

POST/v2/app/rmm-checks/device/:deviceId/assign/:checkId

Assign an existing check directly to a device. Requires an active RMM license. Creates a device-scoped rmm_check_assignments row for this check. Fails if the check is already directly assigned to this device.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/:deviceId/assign/:checkId
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
deviceIdrequiredinteger
checkIdrequiredinteger

Response 201

FieldTypeDescription
messagestring
Example response
JSON
{
  "message": "Saved"
}

Errors

StatusMessage
404User not found
409Already assigned

Example request

Bash
curl -X POST 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/device/1/assign/1' \
  -H "X-API-Key: $BRAMBLE_KEY"

#List recent alert log entries

GET/v2/app/rmm-checks/alerts

List recent alert log entries. Requires an active RMM license. Returns the most recent 200 alert log rows for the tenant (both firing and resolved), newest first.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Response 200

FieldTypeDescription
alertsarray of any
Example response
JSON
{
  "alerts": []
}

Errors

StatusMessage
404User not found

Example request

Bash
curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Manually resolve (dismiss) a firing alert

POST/v2/app/rmm-checks/alerts/:id/resolve

Manually resolve (dismiss) a firing alert. Requires an active RMM license. Marks the alert row resolved and stamps resolved_at. Only affects alerts currently in firing status.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/:id/resolve
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Path parameters

NameTypeDescription
idrequiredinteger

Response 200

FieldTypeDescription
messagestring
Example response
JSON
{
  "message": "Saved"
}

Errors

StatusMessage
404User not found
404Alert not found or already resolved

Example request

Bash
curl -X POST 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/42/resolve' \
  -H "X-API-Key: $BRAMBLE_KEY"

#Acknowledge firing alerts

POST/v2/app/rmm-checks/alerts/acknowledge

Acknowledge firing alerts. "Requires an active RMM license. Marks firing alerts as seen (acknowledged_at, acknowledged_by); they stay firing and resolve themselves when the check passes. Send ids (an array of alert IDs), or all = true for every firing alert; add undo = true to clear the acknowledgement."

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/acknowledge
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Request body JSON

NameTypeDescription
idsarray of any
allany
undoany

Response 200

FieldTypeDescription
changedinteger
Example response
JSON
{
  "changed": 1
}

Errors

StatusMessage
400Choose alerts to acknowledge
404User not found

Example request

Bash
curl -X POST 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/acknowledge' \
  -H "X-API-Key: $BRAMBLE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":[],"all":"…","undo":"…"}'

#List currently firing alerts

GET/v2/app/rmm-checks/alerts/active

List currently firing alerts. Requires an active RMM license. Returns all alert log rows for the tenant with status firing, newest first.

Address
https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/active
Requires
Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: RMM.

Response 200

FieldTypeDescription
alertsarray of any
Example response
JSON
{
  "alerts": []
}

Errors

StatusMessage
404User not found

Example request

Bash
curl -X GET 'https://<your-org>.brambleit.cloud/api/v2/app/rmm-checks/alerts/active' \
  -H "X-API-Key: $BRAMBLE_KEY"