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

UpdateAlertChannel

Update an existing notification channel configuration

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the channel to update

Body Fields

  • nameStringRequired

    New channel name

    Example: Updated Ops Channel

  • descriptionStringRequired

    New channel description

    Example: Updated description

  • configObjectRequired

    New channel configuration

    Example: (nested object)

  • templateIdStringRequired

    New template identifier

    Example: tmpl-email-002

  • statusStringRequired

    New channel status

    Example: disabled

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

PUT/api/v1/alerting/channels/{uuid}

/api/v1/alerting/channels/{uuid}

Operation ID

UpdateAlertChannel

Permalink

Request Example

curl -X PUT '{host}/api/v1/alerting/channels/{uuid}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Updated Ops Channel","description":"Updated description","config":"(nested object)","templateId":"tmpl-email-002","status":"disabled"}'

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