Get input-widget config values on a shared dashboard

GET /api/public/dashboards/{token}/config

Mirror of GET /api/dashboards/{id}/config. Gated: 503 when the input kill switch ENVOY_PUBLIC_DASHBOARD_INPUT_ENABLED is off (default), 403 when the dashboard's allow_public_input is not true.

Operation ID: getPublicDashboardConfig

Authentication

No authentication is required.

Path parameters

• token — string, required

Success responses

200

Current config values

Content type: application/json

• Reference: DashboardConfigResponse
  • Type: object
  • Properties:
    • config (object, required) — Current job_config values keyed by each input widget's config_key.
      • Description: Current job_config values keyed by each input widget's config_key.
      • Additional properties: allowed

Error responses

403

Public input not enabled for this dashboard

404

Resource not found

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

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

503

Public dashboard input disabled on this server

Examples

cURL

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

JavaScript (fetch)

const response = await fetch('https://your-envoy.example.com/api/public/dashboards/YOUR_TOKEN/config', {
  method: 'GET',
});
 
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);