Alert rules API

GET/v1/alert-rules

List the alert rules configured for your workspace. Each rule includes its name, trigger, scope configuration, and whether it is enabled. Results are limited to the organization nodes you have access to. Microsoft Teams workflow URLs in config.teamsUrls and web addresses in config.recipients are credentials, so the response shows them masked: the host and the last four characters, for example https://prod-12.westus.logic.azure.com/…?sig=••••a1b2.

curl "https://api.brixsignage.com/v1/alert-rules" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/alert-rules

Create an alert rule with a name, trigger, optional config, optional enabled flag, and optional nodeId. If the scope named in config does not resolve to an existing target, the request is refused rather than saved. A Microsoft Teams channel is also refused unless config.teamsUrls contains at least one valid Microsoft Teams Workflow HTTPS URL. The response shows each URL masked. **Notes.** - The 201 body is the row as written, not re-read: nodeId is absent when the create did not set one.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/alert-rules" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 The location does not exist.

Response 422 `name` or `trigger` is missing, the scope target does not exist, or a Microsoft Teams URL is not a workflow URL.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/alert-rules/{id}

Get one alert rule, including its full trigger configuration. Access is limited to the organization nodes you can see. Microsoft Teams workflow URLs in config.teamsUrls and web addresses in config.recipients are credentials, so the response shows them masked: the host and the last four characters, for example https://prod-12.westus.logic.azure.com/…?sig=••••a1b2.

curl "https://api.brixsignage.com/v1/alert-rules/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/alert-rules/{id}

Update an alert rule's name, trigger, config, enabled flag, or nodeId. The same scope validation used when creating a rule applies here. To keep a saved URL, send its masked value back unchanged. To replace it, send the new URL. A masked value that matches no saved URL is refused.

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/alert-rules/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No rule with this id.

Response 409 `conflict`: changed since `baseUpdatedAt`; the body carries `current`.

Response 422 The scope target does not exist, a Microsoft Teams URL is not a workflow URL, or a masked URL matches no saved URL.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/alert-rules/{id}

Delete an alert rule. It moves to the recycle bin and stops firing immediately.

curl -X DELETE "https://api.brixsignage.com/v1/alert-rules/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such alert rule in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/alert-rules/{id}/restore

Restore an alert rule that was deleted within the last 30 days. The rule resumes firing once restored.

curl -X POST "https://api.brixsignage.com/v1/alert-rules/{id}/restore" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such alert rule in this workspace, or it was purged.

Response 409 `not_deleted`: the rule is not in the recycle bin.

Response 5XX Server error. The body carries a `requestId` to quote to support.