Skip to main content
ZStack
Alerting & Response/Alert Routing & Policies

ReceiveVmalertAlerts

Receive authenticated packaged-vmalert notifications through the Alertmanager API-compatible notifier endpoint. The installer-managed X-Webhook-Secret is required and is shared only by zmetis and the two packaged vmalert instances.

POST/api/v2/alerts

Operation ID

ReceiveVmalertAlerts

Since

1.2.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • received
    Integer

    Number of alerts received in the payload

    Example: 5

  • created
    Integer

    Number of new alerts created

    Example: 3

  • updated
    Integer

    Number of existing alerts updated

    Example: 1

  • skipped
    Integer

    Number of duplicate alerts skipped

    Example: 1

  • injected
    Integer

    Number of alerts injected into the pipeline

    Example: 4

  • fallback
    Boolean

    Whether fallback processing was used

    Example: false

  • fallbackReason
    String

    Reason for fallback if applicable

    Example: primary channel unavailable

Change History

View all change history

  • Change Time

    AddedRequest parameters X-Webhook-Secret
    View API