Component schema

SyntheticCheckLocationEntry

object1 direct reference

Definition

object

stringrequired

The value a synthetic check definition stores to target this location: the region identifier for a public region, and the Dash0-assigned opaque id for a private location.

SyntheticCheckLocationKindrequired

public: A Dash0-operated region, available to every organization.
private: A location the organization runs itself, visible only to that organization.

"public""private"

allOf

Private locations only. The label to show for the location. It is not unique, because two of an organization's locations may carry the same value after a re-registration, so display it alongside id when it repeats.

string

Private locations only. When Dash0 first registered the location.

allOf

Private locations only. Public regions are operated by Dash0 and report no per-location health here.

Used by 1

These schemas and endpoints reference this type directly.

EndpointGET /api/synthetic-checks/locations

json

OpenAPI source1234567891011121314151617181920212223242526272829303132333435363738
{
  "type": "object",
  "properties": {
    "id": {
      "description": "The value a synthetic check definition stores to target this location: the region\nidentifier for a public region, and the Dash0-assigned opaque id for a private\nlocation.\n",
      "type": "string",
      "example": "synthetic_location_01k3z8v9c7f2mb8xq5r0d4n6ty"
    },
    "kind": {
      "$ref": "#/components/schemas/SyntheticCheckLocationKind"
    },
    "locationId": {
      "description": "Private locations only. The label to show for the location. It is not unique, because\ntwo of an organization's locations may carry the same value after a re-registration,\nso display it alongside `id` when it repeats.\n",
      "allOf": [
        {
          "$ref": "#/components/schemas/SyntheticPrivateLocationLocationId"
        }
      ]
    },
    "createdAt": {
      "description": "Private locations only. When Dash0 first registered the location.",
      "type": "string",
      "format": "date-time"
    },
    "health": {
      "description": "Private locations only. Public regions are operated by Dash0 and report no per-location\nhealth here.\n",
      "allOf": [
        {
          "$ref": "#/components/schemas/SyntheticPrivateLocationHealth"
        }
      ]
    }
  },
  "required": [
    "id",
    "kind"
  ]
}