Update dashboard API config — StatusDashboard Docs

PUT /app/dashboards/{id}/api

Replaces the public status JSON API configuration for a dashboard. This is a full replacement. Requires the API access feature entitlement.

The public customer contract lives at GET https://<your-status-hostname>/api/status and is documented in the Status API platform guide.

Path parameters

Parameter	Description
`id`	The UUID of the dashboard.

Request

See API Basics for required headers.

Request body

Field	Type	Description
`enabled`	boolean	Whether the public status JSON API is active for this dashboard.

No additional fields are accepted.

Sample request

curl -X PUT https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/api \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": true }'

Sample response

Status: 200 OK

{
  "enabled": true
}

Error responses

Status	When
`400`	Validation failure — missing `enabled` or unknown fields in the body.
`403`	Insufficient permissions, or the API access feature is not enabled.
`404`	Dashboard not found or does not belong to the caller's organization.