Skip to main content
ZStack
Alerting & Response/Alert Channels & Integrations

ListAlertChannels

List all notification channels with pagination support

GET/api/v1/alerting/channels

Operation ID

ListAlertChannels

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

Query Parameters

  • page
    Integer

    1-based page number; 0 means no pagination 1-based page number; 0 means no pagination

    Example: 0

  • pageSize
    Integer

    Results per page; default 20, max 200 Results per page; default 20, max 200

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of notification channels

    Example: (nested array)

    • uuid
      String

      Unique identifier of the channel

      Example: chan-001

    • name
      String

      Human-readable channel name

      Example: Ops Email Channel

    • description
      String

      Description of the channel purpose

      Example: Email notifications for operations team

    • type
      String

      Channel type: email, webhook, dingtalk, etc.

      Example: email

    • status
      String

      Channel status: active or disabled

      Example: active

    • config
      Object

      Channel-specific configuration (varies by type). Stored credentials are returned as the redaction placeholder ***.

      Example: (nested object)

    • templateId
      String

      Message template identifier for rendering

      Example: tmpl-email-001

    • alertCount
      String

      Number of alerts sent through this channel

      Example: 150

    • createDate
      String

      Timestamp when the channel was created

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

    • lastOpDate
      String

      Timestamp of the last channel modification

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

  • total
    Integer

    Total number of channels

    Example: 5

  • limit
    Integer

    Maximum items per page

    Example: 20

  • offset
    Integer

    Offset from start of result set

    Example: 20