Component schema

OperationPatternRuleLabels

object1 direct reference

Definition

string

Unique server-generated ID of this Pattern Rule. Set by the server on creation; must not be provided on create (a POST body containing it is rejected with 400).

string

Stable, client-chosen label for idempotent apply-by-name (IaC/Terraform-style) workflows, resolved via {originOrId} on every path below. Client-provided value wins if given; a machine-token caller that omits it gets a server-generated api-<uuid> fallback so the rule still classifies as API-managed; a UI (Clerk) or OAuth caller that omits it keeps a null origin. Immutable after creation: a value supplied on update is silently ignored, never rejected, so a normal GET -> edit spec -> PUT round trip doesn't have to strip it back out first. Must not itself look like a UUID (rejected with 400 on create) -- origins and ids are deliberately disjoint namespaces so {originOrId} resolution is never ambiguous.

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"

string

Dataset this Pattern Rule belongs to. On create, the dataset query parameter is authoritative over this field whenever both are present -- this field is only consulted as a fallback when the query parameter is absent. Immutable after creation: an update whose value disagrees with the stored row is rejected with 400.

Used by 1

These schemas and endpoints reference this type directly.

SchemaOperationPatternRuleMetadata

json

OpenAPI source12345678910111213141516171819
{
  "properties": {
    "dash0.com/id": {
      "description": "Unique server-generated ID of this Pattern Rule. Set by the server on creation; must not be provided on create (a `POST` body containing it is rejected with 400).",
      "type": "string"
    },
    "dash0.com/origin": {
      "description": "Stable, client-chosen label for idempotent apply-by-name (IaC/Terraform-style) workflows, resolved via `{originOrId}` on every path below. Client-provided value wins if given; a machine-token caller that omits it gets a server-generated `api-<uuid>` fallback so the rule still classifies as API-managed; a UI (Clerk) or OAuth caller that omits it keeps a `null` origin. Immutable after creation: a value supplied on update is silently ignored, never rejected, so a normal GET -> edit spec -> PUT round trip doesn't have to strip it back out first. Must not itself look like a UUID (rejected with 400 on create) -- origins and ids are deliberately disjoint namespaces so `{originOrId}` resolution is never ambiguous.",
      "type": "string"
    },
    "dash0.com/source": {
      "$ref": "#/components/schemas/CrdSource"
    },
    "dash0.com/dataset": {
      "description": "Dataset this Pattern Rule belongs to. On create, the `dataset` query parameter is authoritative over this field whenever both are present -- this field is only consulted as a fallback when the query parameter is absent. Immutable after creation: an update whose value disagrees with the stored row is rejected with 400.",
      "type": "string"
    }
  }
}