Dashboard
Get Dashboard
Endpoint to retrieve a single Dashboard by ID
post/dashboard/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScripthttps://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/dashboard/:id/get-item/post.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Dashboard to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"pageTitle": true,
"theme": true
}
}Response
Successful response
Example response
{
"data": {
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "Production Monitoring Dashboard",
"slug": "example-slug-value",
"description": "Dashboard for monitoring production infrastructure and services",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"dashboardViewConfig": {
"key": "value",
"nested": {
"data": 123
}
},
"pageTitle": "Example short text",
"pageDescription": "This is an example of longer text content that might be stored in this field.",
"logoFileId": "123e4567-e89b-12d3-a456-426614174000",
"darkThemeLogoFileId": "123e4567-e89b-12d3-a456-426614174000",
"faviconFileId": "123e4567-e89b-12d3-a456-426614174000",
"theme": "Light",
"isPublicDashboard": true,
"enableMasterPassword": true,
"masterPassword": "hashed_string_value",
"ipWhitelist": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database."
}
}Changes
No recorded changes to this operation across all 1 revision of this API.