Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Channels & Integrations
GETAlertingSince 1.0SynchronousAuth Required

ListAlertIntegrations

List all alert integrations with managed platforms

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • pageInteger

    Page number for pagination (1-based) Page number for pagination (1-based)

    Example: 0

  • sizeInteger

    Page size for pagination Page size for pagination

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of alert integration entries

    Example: (nested array)

    • uuidString

      Unique identifier of the integration entry

      Example: integ-001

    • platformUuidString

      Platform UUID this integration connects to

      Example: plat-001-abc

    • targetStateString

      Desired integration state (enabled or disabled)

      Example: enabled

    • currentStateString

      Actual current state of the integration

      Example: enabled

    • webhookUrlString

      Webhook URL configured on the platform

      Example: https://zcf.example.com/api/v1/alerting/receive

    • webhookIdString

      Webhook identifier on the platform side

      Example: wh-plat-001

    • lastReconcileAtString

      Timestamp of the last reconciliation check

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

    • driftCountInteger

      Number of detected configuration drifts

      Example: 20

    • lastErrorString

      Last error message from reconciliation

      Example: timeout after 30s

    • createDateString

      Timestamp when the integration was created

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

    • lastOpDateString

      Timestamp of the last operation on the integration

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

    • platformNameString

      Human-readable name of the platform

      Example: Production ZStack

    • productTypeString

      Product type of the platform

      Example: zstack

  • totalInteger

    Total number of integrations

    Example: 3

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Offset from start of result set

    Example: 20

Endpoint

GET/api/v1/alerting/integrations

/api/v1/alerting/integrations

Operation ID

ListAlertIntegrations

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/integrations' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 3,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history