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

ListAlertChannels

List notification channels by stored name. search and repeated searchTerms are ORed as case-insensitive literal substrings, after trimming, ignoring empty terms and deduplicating. Example: ?search=Telegram&searchTerms=Ops&searchTerms=Backup. Results are independent of Accept-Language; any display-name mapping is provided by the caller. Filtering precedes total count and pagination; order is createDate descending, then UUID ascending.

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

  • search
    String

    Original keyword, matched against the stored name as a case-insensitive literal substring. Trimmed and ORed with searchTerms; empty terms are ignored. No translation is performed.

  • searchTerms
    List

    Additional literal name keywords, ORed with search. Use repeated query parameters: searchTerms=Ops&searchTerms=Backup (not a comma-separated list). Terms are trimmed, empty terms ignored and duplicates removed. All-empty input means no search. Apply standard URL encoding: + or %20 for a space, %2B for a literal plus.

  • alarmType
    String

    Optional channel classification filter: resource or event; omitted returns both types and composes with search and pagination

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

    • language
      String

      Notification language: en-US or zh-CN

      Example: en-US

    • alarmType
      String

      Channel classification: resource or event; independent of the bound template type

      Example: event

  • 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

Change History

View all change history

  • Change Time

    AddedRequest parameters alarmTypeAddedResponse fields alarmType
    View API

  • Change Time

    AddedRequest parameters search, searchTermsAddedResponse fields language
    View API