List the alerts that fire now and the alert history

GET

/api/notifications/alerts

const url = 'https://opfield.example.com/api/notifications/alerts?page=1&limit=50&status=firing&category=hosting_vm&severity=info';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://opfield.example.com/api/notifications/alerts?page=1&limit=50&status=firing&category=hosting_vm&severity=info' \
  --header 'Authorization: Bearer <token>'

Status firing (the default) lists what fires now; resolved lists the history, kept 30 days (an event rule records each occurrence resolved at once); all lists both. Newest first. Each alert carries its rule (ruleId, ruleName, ruleType, category, metric, eventPattern), the resource (resourceType, resourceId, resourceName), the message notified, firedAt, resolvedAt, durationSeconds and the template details. Filter by ruleId, category, severity, resourceType, resourceId (also a node id, finding its disk and container alerts, or the resource name), since and until (firedAt, ISO 8601), and search (rule name, resource name or id, message). Alerts fired before 2.12.3 have no resourceName or message. Needs notifications:alerts:view.

Authorizations

bearerAuth

Parameters

Query Parameters

page

integer

default: 1 >= 1

limit

integer

default: 50 >= 1 <= 100

status

string

default: firing

Allowed values: firing resolved all

ruleId

string format: uuid

category

string

Allowed values: hosting_vm hosting_account node container build compose proxy pages opfield logging integration certificate security database_postgres database_clickhouse database_redis managed_storage app backup domain pki inference relay_pool docker_availability

severity

string

Allowed values: info warning critical

resourceType

string

<= 50 characters

resourceId

string

<= 255 characters

since

string | null

until

string | null

search

string

<= 255 characters

Responses

200

Successful response

application/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

string

name

string

key

additional properties

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Slack alerts",
      "enabled": true,
      "status": "success"
    }
  ]
}

400

Bad request

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}