Manage Alerting

Retrieve a list of check rule ids

get/api/alerting/check-rules

Request

  • Base URL: https://api.eu-west-1.aws.dash0.com
  • URL: https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules
  • Auth: none declared

Query parameters

datasetstring

Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

idPrefixstring

If provided, only check rules for which the origin starts with the given string are returned. (deprecated)

The originPrefix query parameter takes precedence over this parameter if both are provided.

originPrefixstring

If provided, only check rules for which the origin starts with the given string are returned.

Response

Successful response in case the list of check rules could be retrieved.

idstring required

The unique identifier of the check rule.

For backward compatibility, this field is also filled with the origin, if it exists. However in a future version, this field will only return the actual check rule ID.

originstring

User defined origin for getting/updating/deleting the alert rule through the API.

source'ui' | 'terraform' | 'operator' | 'dash0-cli' | 'platform' | 'identity-provider' | 'api'

Origin of a Dash0 resource, derived from dash0.com/origin on read.

  • ui: created interactively in the Dash0 UI.
  • terraform: managed via the Dash0 Terraform provider.
  • operator: managed via the Dash0 Kubernetes operator.
  • dash0-cli: managed via the Dash0 CLI.
  • platform: owned by Dash0 rather than by anyone in your organization. Covers both resources Dash0 generates from another resource you own (the recording rules an SLO produces) and resources Dash0 ships with the product (the built-in views).
  • identity-provider: a team whose membership Dash0 keeps in sync with a directory group from the organization's identity provider. Membership edits made by hand revert on the next reconcile.
  • api: created directly through the API, and the fallback for any origin whose prefix is not recognized.

New values may be added over time. Treat an unrecognized value as api rather than rejecting the response.

datasetstring required

Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

namestring

Human-readable and templatable name for the check. In Prometheus alerting rules this is called "alert".

Changes

No recorded changes to this operation across all 1 revision of this API.