Component schema

SyntheticCheckAnnotations

object1 direct reference

Definition

string

Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.

string

Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.

Used by 1

These schemas and endpoints reference this type directly.

SchemaSyntheticCheckMetadata

json

OpenAPI source12345678910111213141516
{
  "properties": {
    "dash0.com/deleted-at": {
      "type": "string",
      "format": "date-time"
    },
    "dash0.com/folder-path": {
      "description": "Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.",
      "type": "string"
    },
    "dash0.com/sharing": {
      "description": "Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.",
      "type": "string"
    }
  }
}