Dash0 acquires Polar Signals

Manage Alerting

Retrieve a list of check rule ids

get/api/alerting/check-rules

Parameters 3

datasetquery
References Dataset

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

stringpattern "^[a-zA-Z0-9_-]{3,26}$"
idPrefixquery

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.

string
originPrefixquery

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

string
bash
Sample request
12
curl --request GET 'https://api.eu-west-1.aws.dash0.com/api/alerting/check-rules' \
  --header "Authorization: Bearer ${DASH0_AUTH_TOKEN}"

Responses

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

array

Array items

References PrometheusAlertRuleApiListItem

The ID, origin, dataset, and the name of a check rule.

stringrequired

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.

string

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

CrdSource

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).
  • 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.

"ui""terraform""operator""dash0-cli""platform""api"
Datasetrequired

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

string

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