--- title: "PUT /public/monitoring/v3/alert" method: PUT path: "/public/monitoring/v3/alert" tags: ["cli_alert_monitoring_v3_21"] --- # PUT /public/monitoring/v3/alert `PUT /public/monitoring/v3/alert` ## Request - Base URL: `https://developers.conduktor.io` (the document declares no server; this is the origin it was published from) - URL: `https://developers.conduktor.io/public/monitoring/v3/alert` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Create or update a Alert **Requires a paid license.** Returns 403 Forbidden on Free plan. ## Query parameters - `appInstance` string - `group` string - `user` string - `dryMode` boolean ## Request body - AlertResourceV3 - `apiVersion` string, required - `kind` 'Alert', required - `metadata` AlertMetadataV3, required - `name` string, required - `appInstance` string - `group` string - `user` string - `spec` union, required - BrokerAlertV3 - `cluster` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'MessageIn' | 'MessageOut' | 'MessageSize' | 'OfflinePartitionCount' | 'PartitionCount' | 'UnderMinIsrPartitionCount' | 'UnderReplicatedPartitionCount', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - Basic - … - Bearer - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'BrokerAlert', required - ConsumerGroupAlertV3 - `cluster` string, required - `consumerGroupName` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'OffsetLag' | 'TimeLag', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - Basic - … - Bearer - … - `body` string - `type` 'Webhook', required - `disable` boolean - `topicName` string - `type` 'ConsumerGroupAlert', required - DataQualityPolicyAlertV3 - `policyName` string, required - `triggerAfter` integer, required - `withinInSeconds` integer, required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - Basic - … - Bearer - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'DataQualityPolicyAlert', required - KafkaConnectAlertV3 - `cluster` string, required - `connectName` string, required - `connectorName` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'FailedTaskCount', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - Basic - … - Bearer - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'KafkaConnectAlert', required - TopicAlertV3 - `cluster` string, required - `topicName` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'MessageCount' | 'MessageIn' | 'MessageOut' | 'MessageSize', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - Basic - … - Bearer - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'TopicAlert', required ## Response `200` - AlertApplyResultV3 - `resource` AlertResourceV3, required - `apiVersion` string, required - `kind` 'Alert', required - `metadata` AlertMetadataV3, required - `name` string, required - `appInstance` string - `group` string - `user` string - `spec` union, required - BrokerAlertV3 - `cluster` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'MessageIn' | 'MessageOut' | 'MessageSize' | 'OfflinePartitionCount' | 'PartitionCount' | 'UnderMinIsrPartitionCount' | 'UnderReplicatedPartitionCount', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'BrokerAlert', required - ConsumerGroupAlertV3 - `cluster` string, required - `consumerGroupName` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'OffsetLag' | 'TimeLag', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - … - `body` string - `type` 'Webhook', required - `disable` boolean - `topicName` string - `type` 'ConsumerGroupAlert', required - DataQualityPolicyAlertV3 - `policyName` string, required - `triggerAfter` integer, required - `withinInSeconds` integer, required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'DataQualityPolicyAlert', required - KafkaConnectAlertV3 - `cluster` string, required - `connectName` string, required - `connectorName` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'FailedTaskCount', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'KafkaConnectAlert', required - TopicAlertV3 - `cluster` string, required - `topicName` string, required - `threshold` integer, required - `operator` 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'NotEqual', required - `metric` 'MessageCount' | 'MessageIn' | 'MessageOut' | 'MessageSize', required - `description` string - `displayName` string - `destination` union - Email1 - `to` string, required - `subject` string, required - `body` string - `type` 'Email', required - Slack1 - `channel` string, required - `type` 'Slack', required - Teams - `url` string, required - `type` 'Teams', required - Webhook - `url` string, required - `method` 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT', required - `headers` MapString - `authentification` union - … - `body` string - `type` 'Webhook', required - `disable` boolean - `type` 'TopicAlert', required - `upsertResult` 'Created' | 'Updated' | 'NotChanged', required ## Other responses - `400`: The request is not valid - `401`: The user is not authenticated - `403`: The user doesn't have sufficient privilege to do this operation - `404`: No alert with this technical id exists - `409`: The request does not match one of the business rules - `500`: An unexpected error occurred in the server --- [API](https://skmtc.dev/conduktor/apis/conduktor-console-api.md) - [All operations](https://skmtc.dev/conduktor/apis/conduktor-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conduktor/apis/conduktor-console-api/revisions/24750c294805?raw)