API Reference

Get a dashboard's raw YAML

View Markdown

GET /api/dashboards/{id}/yaml

Returns the snapshotted dashboard YAML for editing. Admin only.

Operation IDgetDashboardYaml

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Raw dashboard YAML

Raw dashboard YAML

Content typeapplication/json

responseobject

5 properties

idinteger

namestring

descriptionstring | null

Nullable: yes

yaml_contentstring

job_idinteger

Parent job id (used for post-delete navigation)

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"
}

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/dashboards/YOUR_ID/yaml' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/dashboards/YOUR_ID/yaml", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

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