Overview
Reference
- AlertEvents
- AlertGroups
- AlertUrgencies
- AlertSources
- Alerts
- Audits
- Authorizations
- CatalogEntities
- CatalogEntityProperties
- CatalogFields
- Catalogs
- Causes
- [DEPRECATED] CustomFieldOptions
- [DEPRECATED] CustomFields
- CustomForms
- DashboardPanels
- Dashboards
- Environments
- EscalationPolicies
- EscalationLevelsPolicies
- EscalationLevelsPath
- EscalationLevels
- EscalationPaths
- FormFieldOptions
- FormFieldPlacementConditions
- FormFieldPlacements
- FormFieldPositions
- FormFields
- FormSetConditions
- FormSets
- Functionalities
- WorkflowTasks
- [DEPRECATED] WorkflowCustomFieldSelections
- WorkflowFormFieldConditions
- WorkflowGroups
- WorkflowRuns
- Workflows
- Heartbeats
- IncidentActionItems
- [DEPRECATED] IncidentCustomFieldSelections
- IncidentEventFunctionalities
- IncidentEventServices
- IncidentEvents
- IncidentFeedbacks
- IncidentFormFieldSelections
- IncidentPermissionSetBooleans
- IncidentPermissionSetResources
- IncidentPermissionSets
- IncidentRetrospectives
- IncidentRetrospectiveSteps
- IncidentRoleTasks
- IncidentRoles
- IncidentStatusPageEvents
- IncidentSubStatuses
- IncidentTypes
- Incidents
- IpRanges
- LiveCallRouters
- OnCallRoles
- OnCallShadows
- OverrideShifts
- PlaybookTasks
- Playbooks
- RetrospectiveTemplates
- Pulses
- RetrospectiveConfigurations
- RetrospectiveProcessGroupSteps
- RetrospectiveProcessGroups
- RetrospectiveProcesses
- RetrospectiveSteps
- Roles
- ScheduleRotationActiveDays
- ScheduleRotationUsers
- ScheduleRotations
- Schedules
- Shifts
- Secrets
- Services
- Severities
- StatusPageTemplates
- StatusPages
- SubStatuses
- Teams
- UserNotificationRules
- Users
- WebhooksDeliveries
- WebhooksEndpoints
Update a dashboard
Update a specific dashboard by id
curl --request PUT \
--url https://api.rootly.com/v1/dashboards/%7Bid%7D \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'
{
"data": {
"id": "5812af00-af87-4ca0-a56a-ca6df321f839",
"type": "dashboards",
"attributes": {
"team_id": 90,
"user_id": 88,
"name": "Test update dashboard",
"description": null,
"slug": "test-update-dashboard",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#FCF2CF",
"icon": "📊",
"auto_refresh": false,
"updated_at": "2025-03-11T19:09:21.936-07:00",
"created_at": "2025-03-11T19:09:17.471-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
dashboards
The name of the dashboard
The description of the dashboard
The owner type of the dashboard
user
, team
Whether the dashboard is public
The date range for dashboard panel data
Whether the dashboard auto-updates the UI with new data.
The hex color of the dashboard
#FCF2CF
, #D7F5E1
, #E9E2FF
, #FAE6E8
, #FAEEE6
The emoji icon of the dashboard
The grouping period for dashboard panel data
day
, week
, month
Response
Unique ID of the dashboard
dashboards
The name of the dashboard
The owner type of the dashboard
user
, team
Whether the dashboard is public
The dashboard team
The dashboard user owner if owner is of type user
The description of the dashboard
The date range for dashboard panel data
The grouping period for dashboard panel data
Whether the dashboard auto-updates the UI with new data.
The hex color of the dashboard
#FCF2CF
, #D7F5E1
, #E9E2FF
, #FAE6E8
, #FAEEE6
The emoji icon of the dashboard
Date of creation
Date of last update
Was this page helpful?
curl --request PUT \
--url https://api.rootly.com/v1/dashboards/%7Bid%7D \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/vnd.api+json'
{
"data": {
"id": "5812af00-af87-4ca0-a56a-ca6df321f839",
"type": "dashboards",
"attributes": {
"team_id": 90,
"user_id": 88,
"name": "Test update dashboard",
"description": null,
"slug": "test-update-dashboard",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#FCF2CF",
"icon": "📊",
"auto_refresh": false,
"updated_at": "2025-03-11T19:09:21.936-07:00",
"created_at": "2025-03-11T19:09:17.471-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
}