Skip to main content
ZStack
Infrastructure/OTA Versions & Policies

UpdateSilencePolicy

Update Silence Policy

POST/api/v1/admin/ota/silence-policy

Operation ID

UpdateSilencePolicy

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

Body Fields

  • policy
    ObjectRequired

    Policy for this resource

    • autoSilenceOnUpgrade
      Boolean

      Whether alert silence windows are automatically created during upgrades

      Example: true

    • bufferMinutes
      Integer

      Extra buffer time in minutes added before and after the upgrade window

      Example: 5

    • suppressedAlertTypes
      List

      Suppressed alert types

      Example: item1,item2

    • notifyOncallBeforeSilence
      Boolean

      Whether the on-call team is notified before a silence is activated

      Example: true

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • autoSilenceOnUpgrade
    Boolean

    Whether alert silence windows are automatically created during upgrades

    Example: true

  • bufferMinutes
    Integer

    Extra buffer time in minutes added before and after the upgrade window

    Example: 5

  • suppressedAlertTypes
    List

    Suppressed alert types

    Example: item1,item2

  • notifyOncallBeforeSilence
    Boolean

    Whether the on-call team is notified before a silence is activated

    Example: true