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
Dashboards
List dashboards
Dashboards
List dashboards
List dashboards
GET
/
v1
/
dashboards
curl --request GET \
--url 'https://api.rootly.com/v1/dashboards?include=SOME_STRING_VALUE&page%5Bnumber%5D=SOME_INTEGER_VALUE&page%5Bsize%5D=SOME_INTEGER_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": [
{
"id": "<string>",
"type": "dashboards",
"attributes": {
"team_id": 123,
"user_id": 123,
"name": "<string>",
"description": "<string>",
"owner": "user",
"public": true,
"range": "<string>",
"period": "<string>",
"auto_refresh": true,
"color": "#FCF2CF",
"icon": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}
],
"links": {
"self": "<string>",
"first": "<string>",
"prev": "<string>",
"next": "<string>",
"last": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
comma separated if needed. eg: panels
Available options:
panels
Response
200 - application/vnd.api+json
success
Unique ID of the dashboard
Available options:
dashboards
The name of the dashboard
The owner type of the dashboard
Available options:
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
Available options:
#FCF2CF
, #D7F5E1
, #E9E2FF
, #FAE6E8
, #FAEEE6
The emoji icon of the dashboard
Date of creation
Date of last update
Was this page helpful?
curl --request GET \
--url 'https://api.rootly.com/v1/dashboards?include=SOME_STRING_VALUE&page%5Bnumber%5D=SOME_INTEGER_VALUE&page%5Bsize%5D=SOME_INTEGER_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": [
{
"id": "<string>",
"type": "dashboards",
"attributes": {
"team_id": 123,
"user_id": 123,
"name": "<string>",
"description": "<string>",
"owner": "user",
"public": true,
"range": "<string>",
"period": "<string>",
"auto_refresh": true,
"color": "#FCF2CF",
"icon": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}
],
"links": {
"self": "<string>",
"first": "<string>",
"prev": "<string>",
"next": "<string>",
"last": "<string>"
}
}