Skip to main content

Delete Alert Rule (V2)

Deletes an existing alert rule by its ID. The current user should be a project admin.

DELETE/v2/alertRules/{ALERT_RULE_ID}
Connection Endpoint

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

shell
export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
ALERT_RULE_IDstringpathrequired

The ID of the alert rule to delete.

bash
export TOKEN="YOUR_API_KEY"
export ALERT_RULE_ID="undefined"

curl --request DELETE \
--url "${BASE_URL}/v2/alertRules/${ALERT_RULE_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
Responses200 OK - application/json

Returns an empty response indicating that the alert rule has been successfully deleted.

Returns an empty response.

codeinteger

Response code.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 0,
    "data": {}
}
Ctrl I