Skip to main content
ZStack
Monitoring & Collection/Scrape Collection

SetScrapeAlertRule

Create or update an alert rule for a specific scrape target

POST/api/v1/monitoring/scrape-health/targets/{targetId}/alert-rules

Operation ID

SetScrapeAlertRule

Since

1.0.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

application/json

Path Parameters

  • targetId
    StringRequired

    UUID of the scrape target to configure the alert rule for

Body Fields

  • consecutiveFails
    IntegerRequired

    Consecutive failure threshold before alert fires

    Example: 3

  • severity
    StringRequired

    Severity of the generated alert (critical, warning)

    Example: critical

  • autoEscalate
    BooleanRequired

    Whether the alert escalates automatically after continued downtime

    Example: true

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the scrape alert rule

    Example: alert-rule-001

  • targetId
    String

    UUID of the scrape target this rule applies to

    Example: target-001-abc

  • consecutiveFails
    Integer

    Number of consecutive failures before firing this alert

    Example: 3

  • severity
    String

    Severity level of the alert (critical, warning)

    Example: critical

  • autoEscalate
    Boolean

    Whether the alert should auto-escalate after extended downtime

    Example: true

  • createdAt
    String

    Created at

    Example: 2026-01-15T08:00:00Z