Component schema

SloAnnotations

object1 direct reference

Definition

Resource annotations. Keys prefixed with dash0.com/ are reserved for Dash0-managed metadata. Some reserved keys are server-managed and ignored when supplied by the caller (e.g. the timestamp annotations); others, like dash0.com/enabled and dash0.com/display-name, are client-settable and honored on write — see the individual property descriptions. dash0.com/display-name holds an optional human-readable display name of the SLO, used instead of metadata.name when set (blank values are treated as unset). Blank keys are ignored. Use any other key for user-defined annotations, which are stored and returned on read. At most 50 user-defined annotations are allowed.

string

Timestamp when the SLO was created. Set by the server; read-only.

string

Timestamp of the last update. Set by the server; read-only.

string

Soft-delete timestamp. Present when the SLO has been deleted but not yet purged. Set by the server; read-only.

string

Optional UI folder path for organising SLOs (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.

string

Whether the SLO is actively tracked. Dash0 extension. Client-settable. Stored as a string; valid values are 'true' and 'false'. Defaults to 'true'.

Additional properties

string

Used by 1

These schemas and endpoints reference this type directly.

SchemaSloMetadata

json

OpenAPI source1234567891011121314151617181920212223242526272829303132333435
{
  "description": "Resource annotations. Keys prefixed with `dash0.com/` are reserved for Dash0-managed\nmetadata. Some reserved keys are server-managed and ignored when supplied by the\ncaller (e.g. the timestamp annotations); others, like `dash0.com/enabled` and\n`dash0.com/display-name`, are client-settable and honored on write — see the\nindividual property descriptions. `dash0.com/display-name` holds an optional\nhuman-readable display name of the SLO, used instead of `metadata.name` when set\n(blank values are treated as unset). Blank keys are ignored. Use any other key for\nuser-defined annotations, which are stored and returned on read. At most 50\nuser-defined annotations are allowed.\n",
  "properties": {
    "dash0.com/created-at": {
      "description": "Timestamp when the SLO was created. Set by the server; read-only.",
      "type": "string",
      "format": "date-time"
    },
    "dash0.com/updated-at": {
      "description": "Timestamp of the last update. Set by the server; read-only.",
      "type": "string",
      "format": "date-time"
    },
    "dash0.com/deleted-at": {
      "description": "Soft-delete timestamp. Present when the SLO has been deleted but not yet purged. Set by the server; read-only.",
      "type": "string",
      "format": "date-time"
    },
    "dash0.com/folder-path": {
      "description": "Optional UI folder path for organising SLOs (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"
    },
    "dash0.com/enabled": {
      "description": "Whether the SLO is actively tracked. Dash0 extension. Client-settable. Stored as a string; valid values are 'true' and 'false'. Defaults to 'true'.",
      "type": "string"
    }
  },
  "additionalProperties": {
    "type": "string"
  }
}