oCoreoCore Docs
API Reference

Alerts

Get active alert count

Returns the count of unresolved alert events for the organization.

GET
/monitoring/alerts/count

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/monitoring/alerts/count" \
  -H "Authorization: <token>"

OK

{
  "count": 0
}

List alert events

Returns paginated alert events with optional resolved filter.

GET
/monitoring/alerts/events

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Query Parameters

resolvedboolean

Filter by resolved status

pageinteger

Page number

Default: 1
per_pageinteger

Items per page

Default: 20
curl -X GET "//api.ocore.dev/api/monitoring/alerts/events?resolved=true&page=1&per_page=20" \
  -H "Authorization: <token>"

OK

{
  "events": [
    {}
  ],
  "page": 0,
  "perPage": 0,
  "total": 0
}

Resolve all alert events

Marks all unresolved alert events for the organization as resolved.

POST
/monitoring/alerts/events/resolve-all

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X POST "//api.ocore.dev/api/monitoring/alerts/events/resolve-all" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Resolve alert event

Marks a single alert event as resolved.

PATCH
/monitoring/alerts/events/{eventId}/resolve

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

eventIdRequiredstring

Alert Event ID (UUID)

curl -X PATCH "//api.ocore.dev/api/monitoring/alerts/events/<string>/resolve" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

List alert rules

Returns all alert rules for the organization, creating preset rules if needed.

GET
/monitoring/alerts/rules

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/monitoring/alerts/rules" \
  -H "Authorization: <token>"

OK

{
  "rules": [
    {}
  ],
  "total": 0
}

Create alert rule

Creates a custom alert rule for the organization.

POST
/monitoring/alerts/rules

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Alert rule creation payload

bodyRequiredobject
curl -X POST "//api.ocore.dev/api/monitoring/alerts/rules" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Created

{}

Delete alert rule

Deletes a custom alert rule. Preset rules cannot be deleted, only disabled.

DELETE
/monitoring/alerts/rules/{ruleId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

ruleIdRequiredstring

Alert Rule ID (UUID)

curl -X DELETE "//api.ocore.dev/api/monitoring/alerts/rules/<string>" \
  -H "Authorization: <token>"

OK

{
  "message": "string"
}

Update alert rule

Updates an existing alert rule by ID.

PUT
/monitoring/alerts/rules/{ruleId}

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Alert rule update payload

bodyRequiredobject

Path Parameters

ruleIdRequiredstring

Alert Rule ID (UUID)

curl -X PUT "//api.ocore.dev/api/monitoring/alerts/rules/<string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

OK

{}

Toggle alert rule

Enables or disables an alert rule.

PATCH
/monitoring/alerts/rules/{ruleId}/toggle

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Request Body

application/jsonRequired

Toggle payload

enabledboolean

Path Parameters

ruleIdRequiredstring

Alert Rule ID (UUID)

curl -X PATCH "//api.ocore.dev/api/monitoring/alerts/rules/<string>/toggle" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

OK

{
  "message": "string"
}

Was this page helpful?
Edit on GitHub

Monitoring

Previous Page

Metrics

Next Page