Query parameters

• organization_id array[string]

  Target organization ID(s). Repeat the param to pass multiple values. Optional for all roles except Customer (where it is ignored).

• include string

  Set to descendants together with organization_id to expand each value to its sub-tree.

  Value is descendants.

• page integer

  1-based page number.

  Minimum value is 1. Default value is 1.

• page_size integer

  Page size. Default 50, max 100.

  Minimum value is 1, maximum value is 100. Default value is 50.

• sort_by string

  Sort column (allowlist). assigned_user_name sorts by the current assignee's display name (case-insensitive; unassigned alerts group together at one end) — active list only, history falls back to its default.

  Values are starts_at, severity, alertname, status, or assigned_user_name. Default value is starts_at.

• sort_direction string

  Values are asc or desc. Default value is desc.

• status array[string]

  Filter alerts by Alertmanager state. Supports multiple values.

  Values are active, suppressed, or unprocessed.

• severity array[string]

  Filter alerts by severity label. Supports multiple values.

  Values are critical, warning, or info.

• system_key array[string]

  Filter alerts by system_key label. Supports multiple values.

• alertname array[string]

  Filter alerts by alertname label (the alert "type" — e.g. HighCPU, DiskFull, CVE-2024-1234). Supports multiple values.

• search string

  Free-text search: case-insensitive substring match on the alert type, its summary and description (any language), the service label, the system name/key/FQDN, the company name and the assignee's name. Combines with the other filters (AND).

• assigned_user_id array[string]

  Filter alerts by current assignee (logto_id of the user, as returned in assigned_to.user_id). Supports multiple values. The literal value none matches unassigned alerts and any alerts assigned to anyone, so assigned_user_id=<my-id>&assigned_user_id=none means "mine or up for grabs".

• silenced boolean

  true keeps only alerts muted by at least one silence (non-empty status.silencedBy), false the others. Unlike status=suppressed, inhibited-only alerts do not count as silenced. Any other value returns 400.

• has_notes boolean

  true keeps only alerts with has_notes: true (at least one operator-written text in their timeline), false the others. Any other value returns 400.

Responses

• 200 application/json

  Paginated list of active alerts

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object
    Hide data attributes Show data attributes object

    • alerts array[object]

      Active alert returned by Mimir Alertmanager. The fan-out includes silenced and inhibited alerts (not just active ones), so callers can render the muted/suppressed state. System identity (id, key, name, type) is carried as labels (system_id, system_key, system_name, system_type), stamped server-side at ingest time.

      Hide alerts attributes Show alerts attributes object

      Active alert returned by Mimir Alertmanager. The fan-out includes silenced and inhibited alerts (not just active ones), so callers can render the muted/suppressed state. System identity (id, key, name, type) is carried as labels (system_id, system_key, system_name, system_type), stamped server-side at ingest time.

      • fingerprint string

        Alertmanager fingerprint (hex hash of labels)

      • labels object

        Alert labels. Always includes server-stamped identity labels (system_id, system_key, system_name, system_type, system_fqdn, system_ipv4, organization_id, organization_name, organization_vat, organization_type) plus the alert's own labels (alertname, severity, ...). Use system_id to link to the system detail page (/systems/:id) and organization_id to link to the organization.

        Hide labels attribute Show labels attribute object

        • * string Additional properties
      • annotations object
        Hide annotations attribute Show annotations attribute object

        • * string Additional properties
      • status object
        Hide status attributes Show status attributes object

        • state string

          Values are active, suppressed, or unprocessed.

        • silencedBy array[string]

          Active silence IDs muting this alert (non-empty → state is "suppressed")

        • inhibitedBy array[string]
      • startsAt string(date-time)
      • endsAt string(date-time)
      • generatorURL string

        Source URL of the alert (set by the pushing agent), if any

      • assigned_to object | null

        Current assignee of the alert (see POST /alerts/assignment), or null when unassigned. Stamped server-side with one batch lookup per page. user_org_* is the assignee's own organization, which may differ from the alert's organization on cross-hierarchy takeover.

        Hide assigned_to attributes Show assigned_to attributes object | null

        • user_id string

          logto_id of the assignee

        • user_name string

          Display name of the assignee

        • user_org_id string

          logto_id of the assignee's own organization

        • user_org_name string

          Name of the assignee's own organization

        • user_org_type string

          Type of the assignee's own organization, resolved when the alert is read

          Values are owner, distributor, reseller, or customer.

        • assigned_at string(date-time)
      • has_notes boolean

        True when the alert's timeline (GET /alerts/activity/{fingerprint}) holds at least one operator-written text: a standalone note, the note taken with an assignment, or a silence comment typed by the operator (the placeholder stored for an empty comment does not count). The timeline is keyed by fingerprint, so notes left on an earlier firing of the same alert count too. Stamped server-side with one batch lookup per page.

    • pagination object
      Hide pagination attributes Show pagination attributes object

      • page integer

        Current page number

        Minimum value is 1.

      • page_size integer

        Number of items per page

        Minimum value is 1, maximum value is 200.

      • total_count integer

        Total number of items

        Minimum value is 0.

      • total_pages integer

        Total number of pages

        Minimum value is 0.

      • has_next boolean

        Whether there is a next page

      • has_prev boolean

        Whether there is a previous page

      • next_page integer | null

        Next page number if available

      • prev_page integer | null

        Previous page number if available

      • sort_by string | null

        Field used for sorting

      • sort_direction string | null

        Sort direction

        Values are asc or desc.

    • warnings array[string]

      Per-tenant errors encountered during fan-out. Always present (empty array when every tenant responded OK). Each entry is a string org <logto_id>: <error>.

• 400 application/json

  Bad request - validation error

  Hide response attributes Show response attributes object

  • code integer

    HTTP error code

  • message string

    Error message

  • data object
    Hide data attributes Show data attributes object

    • type string

      Type of error

      Values are validation_error or external_api_error.

    • errors array[object]
      Hide errors attributes Show errors attributes object

      • key string

        Field name that failed validation

      • message string

        Error code or message

      • value string

        Value that failed validation

    • details

      Additional error details

• 401 application/json

  Unauthorized - invalid or missing token

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object | null
• 403 application/json

  Forbidden - insufficient permissions

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object | null
• 500 application/json

  Internal server error

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object | null