Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Versions & Policies
GETOTASince 1.0SynchronousAuth Required

GetPlanSilenceSummary

Get Plan Silence Summary

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • planIdStringRequired

    ID of the upgrade plan to retrieve silence summary for

Responses

200 OK

On success, this API returns the following response structure.

  • planIdString

    ID of the upgrade plan this silence summary covers

    Example: plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • totalBatchesInteger

    Total number of batches that had silence windows created

    Example: 4

  • batchRecordsList

    Batch records

    Example: (nested array)

    • planIdString

      ID of the upgrade plan this silence record belongs to

      Example: plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • batchNInteger

      Batch number this silence record was created for

      Example: 1

    • silenceIdString

      ID of the alert manager silence created for this batch

      Example: silence-abc123

    • agentIdsList

      Agent ids

      Example: item1,item2

    • createdAtString

      Created at

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

    • releasedAtString

      Released at

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

    • suppressedCountInteger

      Total number of alerts suppressed during this batch silence window

      Example: 3

  • totalSuppressedInteger

    Total count of all alerts suppressed across all batches

    Example: 12

Endpoint

GET/api/v1/ota/plans/{planId}/silence-summary

/api/v1/ota/plans/{planId}/silence-summary

Operation ID

GetPlanSilenceSummary

Permalink

Request Example

curl -X GET '{host}/api/v1/ota/plans/{planId}/silence-summary' -H 'Authorization: Bearer {token}'

Response Example

200
{"planId": "plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "totalBatches": 4, "batchRecords": [{"planId": "plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "batchN": 1, "silenceId": "silence-abc123", "agentIds": ["value"], "createdAt": "2026-01-15T08:00:00Z", "releasedAt": "2026-01-15T08:00:00Z", "suppressedCount": 3}], "totalSuppressed": 12}

Change History

This API has no change history records yet.

View all change history