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

ManageAlertIntegration

Enable or disable alert integration for a managed platform

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • platformUuidStringRequired

    Platform UUID to manage integration for

Body Fields

  • targetStateStringRequired

    Target state: enabled or disabled

    Example: enabled

Responses

200 OK

On success, this API returns the following response structure.

  • uuidString

    Unique identifier of the integration entry

    Example: integ-001

  • platformUuidString

    Platform UUID this integration connects to

    Example: plat-001-abc

  • targetStateString

    Desired integration state (enabled or disabled)

    Example: enabled

  • currentStateString

    Actual current state of the integration

    Example: enabled

  • webhookUrlString

    Webhook URL configured on the platform

    Example: https://zcf.example.com/api/v1/alerting/receive

  • webhookIdString

    Webhook identifier on the platform side

    Example: wh-plat-001

  • lastReconcileAtString

    Timestamp of the last reconciliation check

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

  • driftCountInteger

    Number of detected configuration drifts

    Example: 20

  • lastErrorString

    Last error message from reconciliation

    Example: timeout after 30s

  • createDateString

    Timestamp when the integration was created

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

  • lastOpDateString

    Timestamp of the last operation on the integration

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

  • platformNameString

    Human-readable name of the platform

    Example: Production ZStack

  • productTypeString

    Product type of the platform

    Example: zstack

Endpoint

POST/api/v1/alerting/integrations/{platformUuid}/manage

/api/v1/alerting/integrations/{platformUuid}/manage

Operation ID

ManageAlertIntegration

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/integrations/{platformUuid}/manage' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"targetState":"enabled"}'

Response Example

200
{
  "uuid": "integ-001",
  "platformUuid": "plat-001-abc",
  "targetState": "enabled",
  "currentState": "enabled",
  "webhookUrl": "https://zcf.example.com/api/v1/alerting/receive",
  "webhookId": "wh-plat-001",
  "lastReconcileAt": "example",
  "driftCount": 20
}

Change History

This API has no change history records yet.

View all change history