Component schema

PrometheusAlertRuleApiListItem

object1 direct reference

Definition

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".

Used by 1

These schemas and endpoints reference this type directly.

EndpointGET /api/alerting/check-rules

json

OpenAPI source123456789101112131415161718192021222324252627
{
  "description": "The ID, origin, dataset, and the name of a check rule.",
  "properties": {
    "id": {
      "description": "The unique identifier of the check rule.\n\nFor backward compatibility, this field is also filled with the origin, if it exists.\nHowever in a future version, this field will only return the actual check rule ID.\n",
      "type": "string"
    },
    "origin": {
      "description": "User defined origin for getting/updating/deleting the alert rule through the API.",
      "type": "string"
    },
    "source": {
      "$ref": "#/components/schemas/CrdSource"
    },
    "dataset": {
      "$ref": "#/components/schemas/Dataset"
    },
    "name": {
      "description": "Human-readable and templatable name for the check. In Prometheus alerting rules this is called \"alert\".",
      "type": "string"
    }
  },
  "required": [
    "id",
    "dataset"
  ]
}