Manage Attribute Pattern Rules (Private BETA)

Update or create an Attribute Pattern Rule by origin or ID

put/api/attribute-pattern-rules/{originOrId}

Upsert semantics, per this API's standard {originOrId} convention: if {originOrId} resolves to an existing rule, it's updated; if it doesn't resolve to anything, a new rule is created for non-UI (machine token/OAuth) callers only --

if {originOrId} looks like a UUID, the new rule is created with that UUID as its dash0.com/id (metadata.labels["dash0.com/origin"] in the body, if any, is stamped normally per POST's rules);
otherwise, {originOrId} itself becomes the new rule's dash0.com/origin and a fresh dash0.com/id is generated.

A UI (Clerk session token) caller gets a strict 404 instead of a create when {originOrId} doesn't resolve -- the UI creates rules via POST only, matching this API's other single-/api/-family resources.

metadata.labels["dash0.com/origin"] is immutable after creation: a value supplied on update is silently ignored, never rejected, so a normal GET -> edit spec -> PUT round trip doesn't need to strip it back out.

metadata.labels["dash0.com/dataset"]/spec.serviceNamespace/spec.serviceName are immutable; a value that disagrees with the stored row is rejected with 400 and the row is left unchanged. Setting spec.ownership to auto_derived is rejected with 400; the only accepted transition is auto_derived -> user_defined (promoting a Miner-inferred rule). Unlike POST, spec.status is required on every PUT -- there is no default, since omitting it could otherwise silently reactivate or deactivate a rule the caller did not intend to touch.

If the incoming payload is identical to what's already stored, the write is skipped entirely and the existing rule is returned as-is, without bumping dash0.com/updated-at -- so re-applying the same manifest (a normal IaC workflow) never spuriously conflicts with itself.

Parameters 2

originOrIdpathrequired

The Attribute Pattern Rule's dash0.com/origin or dash0.com/id.

string

datasetqueryrequired

The dataset the Pattern Rule belongs to.

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}$"

bash

Sample request123456789101112
curl --request PUT 'https://api.eu-west-1.aws.dash0.com/api/attribute-pattern-rules/123e4567-e89b-42d3-a456-426614174000?dataset=default' \
  --header "Authorization: Bearer ${DASH0_AUTH_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "kind": "Dash0AttributePatternRule",
  "metadata": {},
  "spec": {
    "serviceName": "example",
    "pattern": "example",
    "status": "active"
  }
}'

Server

Request body required

References AttributePatternRuleUpdateRequest

References AttributePatternRuleDefinition

A Pattern Rule abstracts a high-cardinality value of the telemetry attribute named by spec.targetAttribute (e.g. /users/1234) into a templated one (e.g. /users/<userId>), so the collector can collapse matching values together. For dash0.operation.name — the default, and the only target attribute mined today — that is the collector's Operation Processor collapsing span operation names. Rows are either authored by a human through this API (spec.ownership: user_defined) or inferred by the miner (spec.ownership: auto_derived).

Unlike most CRD-enveloped resources in this API, Pattern Rules have no independent, user-editable display name, versioning, folder, or sharing concept -- metadata.name is server-computed (see below). They are addressable either by their server-generated metadata.labels["dash0.com/id"] or by metadata.labels["dash0.com/origin"] (an IaC/Terraform-style stable label) -- see {originOrId} on each path below. metadata.labels["dash0.com/dataset"]/spec.serviceNamespace/spec.serviceName identify the partition (dataset + service) a rule belongs to, and are immutable once the rule is created.

stringrequired

"Dash0AttributePatternRule"

AttributePatternRuleMetadatarequired

AttributePatternRuleSpecrequired

Responses

The updated or newly-created Attribute Pattern Rule

References AttributePatternRuleResponse

References AttributePatternRuleDefinition

stringrequired

"Dash0AttributePatternRule"

AttributePatternRuleMetadatarequired

AttributePatternRuleSpecrequired