Skip to main content
ZStack
Monitoring & Collection/Scrape Collection

SetMaintenanceMode

Enable or disable maintenance mode for a scrape target to suppress alerts

PUT/api/v1/monitoring/scrape-health/targets/{targetId}/maintenance

Operation ID

SetMaintenanceMode

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 target to put into or remove from maintenance mode

Body Fields

  • enabled
    BooleanRequired

    True to enable maintenance mode, false to disable

    Example: true

  • reason
    StringRequired

    Reason for entering maintenance mode

    Example: scheduled OS upgrade

Responses

200 OK
200 OK

On success, this API returns an empty JSON object {}.