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

CreateAlertChannel

Create a new notification channel for alert delivery

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable channel name

    Example: Ops Email Channel

  • descriptionStringRequired

    Description of the channel purpose

    Example: Email notifications for operations team

  • typeStringRequired

    Channel type: email, webhook, dingtalk, etc.

    Example: email

  • configObjectRequired

    Channel-specific configuration

    Example: (nested object)

  • templateIdStringRequired

    Message template identifier for rendering

    Example: tmpl-email-001

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

POST/api/v1/alerting/channels

/api/v1/alerting/channels

Operation ID

CreateAlertChannel

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/channels' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Ops Email Channel","description":"Email notifications for operations team","type":"email","config":"(nested object)","templateId":"tmpl-email-001","status":"active"}'

Response Example

200
{
  "uuid": "chan-001",
  "name": "Ops Email Channel",
  "description": "Email notifications for operations team",
  "type": "email",
  "status": "active",
  "config": null,
  "templateId": "tmpl-email-001",
  "alertCount": 150
}

Change History

This API has no change history records yet.

View all change history