Schedule
A schedule periodically runs a dashboard on a cron cadence. Each run executes the dashboard's queries to refresh its cached data and sends a snapshot of the dashboard to the schedule's subscribers. See Manage scheduled dashboard updates and subscriptions for details.
Schedule object
A schedule periodically runs a dashboard on a cron cadence. Each run executes the dashboard's queries to refresh its cached data and sends a snapshot of the dashboard to the schedule's subscribers. See Manage scheduled dashboard updates and subscriptions for details.
- schedule_idstringOutput only
UUID identifying the schedule.
- dashboard_idstringOutput only
UUID identifying the dashboard to which the schedule belongs.
- cron_scheduleobject
The cron expression and time zone that define when the schedule runs.
Show child attributesHide child attributes
- quartz_cron_expressionstring
A cron expression in Quartz syntax that defines when the schedule runs. See the Quartz cron trigger tutorial for the syntax.
- timezone_idstring
A Java timezone id. The schedule will be resolved with respect to this timezone. See Java TimeZone for details.
- pause_statusstring
Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.
UNPAUSEDPAUSED
- display_namestring<= 255 characters
The name of the schedule, as shown in the dashboard's list of schedules.
- etagstring
The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.
- create_timestringOutput only
A timestamp indicating when the schedule was created.
- update_timestringOutput only
A timestamp indicating when the schedule was last updated.
- warehouse_idstring
The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If omitted, the warehouse of the published dashboard is used.
Get dashboard schedule GA
GET
Get dashboard schedule.
The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.
Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the schedule belongs.
- schedule_idstringRequiredpath
UUID identifying the schedule.
Response
Returns the Schedule object.
List dashboard schedules GA
GET
List dashboard schedules.
The caller must be a workspace user with one of the following entitlements: Workspace access, Databricks SQL access, or Consumer access.
Account-level users who are not members of the workspace cannot call this endpoint, even if the dashboard has been shared with them.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the schedules belong.
- page_sizeint32[ 1 .. 100 ]query
The number of schedules to return per page.
- page_tokenstringquery
A page token, received from a previous
ListSchedulescall. Use this to retrieve the subsequent page.
Response
Returns a list of Schedule objects.
Create dashboard schedule GA
POST
Creates a schedule for a dashboard. The dashboard must be published before a schedule can be created for it.
Requires the Databricks SQL access entitlement. Grant Databricks SQL access in addition to Workspace access.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the schedule belongs.
Request body
The schedule to create. A dashboard is limited to 10 schedules.
- cron_scheduleobjectRequired
The cron expression and time zone that define when the schedule runs.
Show child attributesHide child attributes
- quartz_cron_expressionstringRequired
A cron expression in Quartz syntax that defines when the schedule runs. See the Quartz cron trigger tutorial for the syntax.
- timezone_idstringRequired
A Java timezone id. The schedule will be resolved with respect to this timezone. See Java TimeZone for details.
- pause_statusstring
Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.
UNPAUSEDPAUSED
- display_namestring<= 255 characters
The name of the schedule, as shown in the dashboard's list of schedules.
- warehouse_idstring
The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If omitted, the warehouse of the published dashboard is used.
Response
Returns the Schedule object.
Update dashboard schedule GA
PUT
Updates a schedule. The request body replaces the stored schedule, so fields omitted from the body are reset to their defaults.
Requires the Databricks SQL access entitlement. Grant Databricks SQL access in addition to Workspace access.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the schedule belongs.
- schedule_idstringRequiredpath
UUID identifying the schedule.
Request body
The schedule to update.
- cron_scheduleobjectRequired
The cron expression and time zone that define when the schedule runs.
Show child attributesHide child attributes
- quartz_cron_expressionstringRequired
A cron expression in Quartz syntax that defines when the schedule runs. See the Quartz cron trigger tutorial for the syntax.
- timezone_idstringRequired
A Java timezone id. The schedule will be resolved with respect to this timezone. See Java TimeZone for details.
- pause_statusstring
Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.
UNPAUSEDPAUSED
- display_namestring<= 255 characters
The name of the schedule, as shown in the dashboard's list of schedules.
- etagstring
The etag for the schedule. Must be left empty on create, must be provided on updates to ensure that the schedule has not been modified since the last read, and can be optionally provided on delete.
- warehouse_idstring
The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If omitted, the warehouse of the published dashboard is used.
Response
Returns the Schedule object.
Delete dashboard schedule GA
DELETE
Deletes a schedule together with all of its subscriptions.
Requires the Databricks SQL access entitlement. Grant Databricks SQL access in addition to Workspace access.
API scopes: dashboards
Parameters
- dashboard_idstringRequiredpath
UUID identifying the dashboard to which the schedule belongs.
- schedule_idstringRequiredpath
UUID identifying the schedule.
- etagstringquery
The etag for the schedule. Optionally, it can be provided to verify that the schedule has not been modified from its last retrieval.