API Reference

Get a shared dashboard definition

GET /api/public/dashboards/{token}

No session auth. Requires a valid share token. Disabled when ENVOY_PUBLIC_DASHBOARDS_ENABLED=false (503).

Operation IDgetPublicDashboard

Authentication

No authentication is required.

Path parameters

tokenstringrequired

Success response body

200Public dashboard metadata and parsed definition

Public dashboard metadata and parsed definition

Content typeapplication/json

responseobject

4 properties

idinteger

namestring

descriptionstring | null

Nullable: yes

dashboardobject

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

503Public dashboards disabled on this server

Public dashboards disabled on this server

No response content schema is documented.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN'

const response = await fetch("https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN", {
  method: "GET",
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);