Retrieve the synthetic check locations available to the organization

Returns Dash0 public regions and the organization's private synthetic locations as one list. kind distinguishes them.

The id of an entry is what a synthetic check definition stores to target it: the region identifier for a public region, and the Dash0-assigned opaque id for a private location. A check may also target a private location by its locationId, which names one location for good. A value equal to a public region identifier always means the region; target a private location with such a locationId by its id.

Deleted private locations are omitted.

Private locations carry health, derived from the workers currently connected to them. health.status is unknown when Dash0 cannot determine the connection state; that is distinct from offline, which reports that no worker is connected.

get/api/synthetic-checks/locations

Request

Base URL: https://api.eu-west-1.aws.dash0.com
URL: https://api.eu-west-1.aws.dash0.com/api/synthetic-checks/locations
Auth: none declared

Response

The locations the organization can target.

idstring required

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.

kind'public' | 'private' required

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

locationIdstring

Customer-chosen identifier for the location, unique within the owning organization only. Two organizations may both use the same value for unrelated locations. Within one organization it names one location for good, deleted or not.

createdAtstring date-time

Private locations only. When Dash0 first registered the location.

Example response

[
  {
    "id": "synthetic_location_01k3z8v9c7f2mb8xq5r0d4n6ty",
    "locationId": "dc-fra-1"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.