From def2e1f4e74ef4d182f10637c9a67754189dcd93 Mon Sep 17 00:00:00 2001 From: Mia Miu Date: Tue, 2 Jun 2026 00:15:12 +1200 Subject: [PATCH] Document private location API fields (#2216) --- .../src/content/docs/reference/private-location.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/apps/docs/src/content/docs/reference/private-location.mdx b/apps/docs/src/content/docs/reference/private-location.mdx index a03596326..3f2fc5993 100644 --- a/apps/docs/src/content/docs/reference/private-location.mdx +++ b/apps/docs/src/content/docs/reference/private-location.mdx @@ -31,6 +31,17 @@ Detailed steps for setting up a private location involve: 3. **Authentication:** Configuring the probe with necessary API keys or tokens to securely authenticate with your openstatus workspace. 4. **Network Access:** Ensuring the deployed probe has network access to the internal services it needs to monitor, as well as outbound access to the openstatus platform. +## Current API surface + +Private locations can currently be created, listed, updated, and deleted from the authenticated dashboard API. The supported private location fields are: + +- `name`: the display name shown in the dashboard. +- `token`: the probe authentication token. +- `monitors`: the monitor IDs attached to the private location. +- `lastSeenAt`: the last time the private location probe connected. + +Additional display metadata such as country, city, or hosting provider is not currently part of the private location model. If you need that information today, include it in the location name, for example `Frankfurt - Hetzner`. + **Example Use Cases:** - Monitoring an internal REST API that is only accessible from within your corporate network. - Checking the health of a database server running on a private subnet. -- 2.51.2