errors.alert-rules.test

Send the rule’s alert now with sample data, to check its mail and webhooks

POST /errors/api/projects/{id}/alert-rules/{ruleId}/testIAM errors:PutAlertRuleChanges state

Request syntax

POST /errors/api/projects/{id}/alert-rules/{ruleId}/test

Path parameters

  • idRequired

    string

    Constraints: uuid

  • ruleIdRequired

    string

    Constraints: uuid

Response

200 with { result }: what delivery did, e.g. "sent: emailed 2; slack webhook 200" or "sent: no recipients"; a failed mail or webhook is reported there, not as an error status. The test is recorded among the rule’s firings and ignores its quiet period and enabled flag. 404 when the project or the rule does not exist.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow errors:PutAlertRule on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud errors alert-rules test id ruleId

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_errors_alert-rules_test.