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

ListAlertChannels

List all notification channels with pagination support

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

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

    Example: 0

  • pageSizeInteger

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

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of notification channels

    Example: (nested array)

    • uuidString

      Unique identifier of the channel

      Example: chan-001

    • nameString

      Human-readable channel name

      Example: Ops Email Channel

    • descriptionString

      Description of the channel purpose

      Example: Email notifications for operations team

    • typeString

      Channel type: email, webhook, dingtalk, etc.

      Example: email

    • statusString

      Channel status: active or disabled

      Example: active

    • configObject

      Channel-specific configuration (varies by type)

      Example: (nested object)

    • templateIdString

      Message template identifier for rendering

      Example: tmpl-email-001

    • alertCountString

      Number of alerts sent through this channel

      Example: 150

    • createDateString

      Timestamp when the channel was created

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

    • lastOpDateString

      Timestamp of the last channel modification

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

  • totalInteger

    Total number of channels

    Example: 5

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Offset from start of result set

    Example: 20

Endpoint

GET/api/v1/alerting/channels

/api/v1/alerting/channels

Operation ID

ListAlertChannels

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history