StatusDashboard
DashboardsContent

Update dashboard content

Replace the content module configuration for a dashboard.

View Markdown

PUT /app/dashboards/{id}/content

Replaces the content module toggles, display order, and uptime history configuration for a dashboard. This is a full replacement.


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

Request body

FieldTypeRequiredDescription
activeIncidentsbooleanYesShow the active incidents section on the status dashboard.
activeMaintenancebooleanYesShow active maintenance windows on the status dashboard.
eventHistorybooleanYesShow the event history section.
scheduledMaintenancebooleanYesShow upcoming scheduled maintenance windows.
informationalbooleanYesShow the informational notices section.
weeklyActivitybooleanYesShow the weekly activity chart.
moduleOrderarray of stringsYesDisplay order of content modules. Must contain each module key. See module keys below.
uptimeHistoryobjectYesUptime history bar chart configuration.
timestampFormatstringYesHow event timestamps are displayed on the status dashboard. One of relative or exact.

uptimeHistory object

FieldTypeDescription
enabledbooleanShow the uptime history section.
daysintegerNumber of days to display. One of 17.

Module keys

The moduleOrder array controls the vertical order of sections on the status dashboard. It must contain all of the following values:

ValueDescriptionOrder
activeIncidentsActive incidents section.Most recently started first.
activeMaintenanceActive maintenance windows section.Most recently started first.
scheduledMaintenanceUpcoming scheduled maintenance section.Soonest upcoming first.
informationalInformational notices and announcements section.Most recently posted first.
weeklyActivityWeekly activity chart.Fixed 7-day window with week navigation.
eventHistoryHistorical closed events section.Most recently resolved first.
componentsComponent status grid.

Sample request

curl -X PUT https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/content \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "activeIncidents": true,
    "activeMaintenance": true,
    "eventHistory": true,
    "scheduledMaintenance": false,
    "informational": true,
    "weeklyActivity": true,
    "moduleOrder": [
      "activeIncidents",
      "activeMaintenance",
      "scheduledMaintenance",
      "informational",
      "weeklyActivity",
      "components",
      "eventHistory"
    ],
    "uptimeHistory": {
      "enabled": true,
      "days": 7
    },
    "timestampFormat": "exact"
  }'

Sample response

Status: 200 OK

{
  "activeIncidents": true,
  "activeMaintenance": true,
  "eventHistory": true,
  "scheduledMaintenance": false,
  "informational": true,
  "moduleOrder": [
    "activeIncidents",
    "activeMaintenance",
    "scheduledMaintenance",
    "informational",
    "components",
    "eventHistory"
  ],
  "uptimeHistory": {
    "enabled": true,
    "days": 7
  },
  "timestampFormat": "exact"
}

Error responses

StatusWhen
400Validation failure — invalid or incomplete moduleOrder, invalid days value, or missing required fields.
403Insufficient permissions.
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.