> ## Documentation Index
> Fetch the complete documentation index at: https://docs.e6data.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resume dashboard

> resume dashboard. POST /api/v1/dashboards/{dashboard_id}/resume. Enable scheduled dashboard refreshes using the current revision. This can start engine work.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json POST /api/v1/dashboards/{dashboard_id}/resume
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/dashboards/{dashboard_id}/resume:
    post:
      tags:
        - Dashboards
      summary: resume dashboard
      description: >-
        resume dashboard. POST /api/v1/dashboards/{dashboard_id}/resume. Enable
        scheduled dashboard refreshes using the current revision. This can start
        engine work.
      operationId: resume_dashboard
      parameters:
        - in: path
          name: dashboard_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Input_app_dashboards_src_models_rs_DashboardMutationRequest
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  dashboard:
                    $ref: >-
                      #/components/schemas/app_dashboards_src_models_rs_DashboardDoc
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    Input_app_dashboards_src_models_rs_DashboardMutationRequest:
      additionalProperties: false
      properties:
        expected_revision:
          minimum: 0
          type: integer
        submission_id:
          $ref: '#/components/schemas/Input_shared_common_src_lib_rs_SubmissionId'
      required:
        - submission_id
        - expected_revision
      type: object
    app_dashboards_src_models_rs_DashboardDoc:
      properties:
        active_definition:
          anyOf:
            - $ref: >-
                #/components/schemas/app_dashboards_src_models_rs_DashboardDefinition
            - type: 'null'
        active_revision:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        created_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        dashboard_id:
          format: uuid
          type: string
        definition:
          $ref: >-
            #/components/schemas/app_dashboards_src_models_rs_DashboardDefinition
        latest_refresh_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        latest_refresh_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
        latest_refresh_status:
          anyOf:
            - $ref: '#/components/schemas/app_dashboards_src_models_rs_RefreshStatus'
            - type: 'null'
        latest_snapshot_at:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
            - type: 'null'
        latest_snapshot_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
        paused:
          type: boolean
        pending_action:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            A persisted activation/pause/delete is retried by the reconciler
            after a restart.
        revision:
          minimum: 0
          type: integer
        updated_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        workload_id:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkloadId'
            - type: 'null'
      required:
        - dashboard_id
        - revision
        - definition
        - active_revision
        - active_definition
        - workload_id
        - paused
        - latest_snapshot_id
        - latest_snapshot_at
        - latest_refresh_id
        - latest_refresh_at
        - latest_refresh_status
        - created_at
        - updated_at
        - pending_action
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    Input_shared_common_src_lib_rs_SubmissionId:
      format: uuid
      type: string
    app_dashboards_src_models_rs_DashboardDefinition:
      properties:
        datasets:
          items:
            $ref: '#/components/schemas/app_dashboards_src_models_rs_DashboardDataset'
          type: array
        description:
          type: string
        name:
          type: string
        options:
          $ref: >-
            #/components/schemas/shared_common_src_lib_rs_WorkloadSubmissionOptions
        parameters:
          additionalProperties:
            $ref: >-
              #/components/schemas/shared_common_src_parameters_rs_ParameterDefinition
          type: object
        retention:
          $ref: '#/components/schemas/app_dashboards_src_models_rs_DashboardRetention'
        schedule:
          $ref: >-
            #/components/schemas/kernel_scheduler_src_scheduling_model_rs_SchedulingPolicy
        widgets:
          items:
            $ref: '#/components/schemas/app_dashboards_src_models_rs_DashboardWidget'
          type: array
      required:
        - name
        - description
        - datasets
        - widgets
        - parameters
        - schedule
        - options
        - retention
      type: object
    shared_common_src_time_rs_WallClockTimestamp:
      properties:
        unix_millis:
          type: integer
      required:
        - unix_millis
      type: object
    app_dashboards_src_models_rs_RefreshStatus:
      oneOf:
        - const: Pending
          type: string
        - const: Running
          type: string
        - const: Cancelling
          type: string
        - const: Cancelled
          type: string
        - const: Succeeded
          type: string
        - const: Failed
          type: string
        - const: Skipped
          type: string
        - const: OutcomeUnknown
          type: string
    shared_common_src_lib_rs_WorkloadId:
      format: uuid
      type: string
    app_dashboards_src_models_rs_DashboardDataset:
      properties:
        dataset_id:
          format: uuid
          type: string
        name:
          type: string
        settings:
          $ref: '#/components/schemas/shared_common_src_lib_rs_QuerySettings'
        source_query_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
        sql:
          type: string
      required:
        - dataset_id
        - name
        - sql
        - settings
        - source_query_id
      type: object
    shared_common_src_lib_rs_WorkloadSubmissionOptions:
      properties:
        compute_requirements:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_lib_rs_ComputeRequirements
            - type: 'null'
        deployment_profile:
          anyOf:
            - type: string
            - type: 'null'
        execution_target:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_ExecutionTarget'
            - type: 'null'
        execution_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        max_attempts:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        missed_run_policy:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_MissedRunPolicy'
            - type: 'null'
        overlap_policy:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_OverlapPolicy'
            - type: 'null'
        parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
          description: Maximum assigned tasks in one run. Unset has no run limit.
        profile:
          anyOf:
            - type: string
            - type: 'null'
        provisioner:
          anyOf:
            - type: string
            - type: 'null'
        queue_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        start_paused:
          type: boolean
        worker_scope:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkerScope'
            - type: 'null'
        xray:
          type: boolean
      required:
        - queue_timeout
        - worker_scope
        - parallelism
        - execution_target
        - execution_timeout
        - compute_requirements
        - max_attempts
        - missed_run_policy
        - overlap_policy
      type: object
    shared_common_src_parameters_rs_ParameterDefinition:
      properties:
        default:
          anyOf:
            - description: JSON value; fields depend on the enclosing document or provider.
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
        enum:
          anyOf:
            - items:
                description: >-
                  JSON value; fields depend on the enclosing document or
                  provider.
              type: array
            - type: 'null'
        nullable:
          type: boolean
        required:
          type: boolean
        type:
          $ref: '#/components/schemas/shared_common_src_parameters_rs_ParameterType'
      required:
        - type
        - required
        - nullable
      type: object
    app_dashboards_src_models_rs_DashboardRetention:
      properties:
        max_age_days:
          minimum: 0
          type: integer
        max_snapshots:
          minimum: 0
          type: integer
      required:
        - max_snapshots
        - max_age_days
      type: object
    kernel_scheduler_src_scheduling_model_rs_SchedulingPolicy:
      oneOf:
        - const: Manual
          type: string
        - const: Immediately
          type: string
        - properties:
            At:
              properties:
                at:
                  $ref: >-
                    #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
              required:
                - at
              type: object
          required:
            - At
          type: object
        - properties:
            Interval:
              properties:
                every:
                  properties:
                    nanos:
                      maximum: 999999999
                      minimum: 0
                      type: integer
                    secs:
                      minimum: 0
                      type: integer
                  required:
                    - secs
                    - nanos
                  type: object
                start_at:
                  $ref: >-
                    #/components/schemas/shared_common_src_time_rs_WallClockTimestamp
              required:
                - start_at
                - every
              type: object
          required:
            - Interval
          type: object
        - properties:
            Cron:
              properties:
                expression:
                  type: string
                timezone:
                  type: string
              required:
                - expression
                - timezone
              type: object
          required:
            - Cron
          type: object
    app_dashboards_src_models_rs_DashboardWidget:
      properties:
        chart:
          $ref: '#/components/schemas/app_dashboards_src_models_rs_ChartConfig'
        dataset_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
        kind:
          $ref: '#/components/schemas/app_dashboards_src_models_rs_WidgetKind'
        layout:
          $ref: '#/components/schemas/app_dashboards_src_models_rs_WidgetLayout'
        markdown:
          anyOf:
            - type: string
            - type: 'null'
        title:
          type: string
        widget_id:
          format: uuid
          type: string
      required:
        - widget_id
        - title
        - dataset_id
        - kind
        - layout
        - chart
        - markdown
      type: object
    shared_common_src_lib_rs_QuerySettings:
      properties:
        ansi_enabled:
          type: boolean
        case_sensitive:
          type: boolean
        current_catalog:
          type: string
        namespace:
          items:
            type: string
          type: array
        time_zone:
          type: string
      required:
        - current_catalog
        - namespace
        - time_zone
        - case_sensitive
        - ansi_enabled
      type: object
    shared_common_src_lib_rs_ComputeRequirements:
      properties:
        cpu_millicores:
          minimum: 1
          type: integer
        memory_bytes:
          minimum: 1
          type: integer
        tuning:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_compute_rs_ComputeTuning'
            - type: 'null'
      required:
        - cpu_millicores
        - memory_bytes
      type: object
    shared_common_src_lib_rs_ExecutionTarget:
      oneOf:
        - const: DataFusion
          type: string
        - const: DuckDb
          type: string
    shared_common_src_lib_rs_MissedRunPolicy:
      oneOf:
        - const: RunOnce
          type: string
        - const: RunAll
          type: string
        - const: Skip
          type: string
    shared_common_src_lib_rs_OverlapPolicy:
      oneOf:
        - const: Wait
          type: string
        - const: Skip
          type: string
        - const: Allow
          type: string
    shared_common_src_lib_rs_WorkerScope:
      oneOf:
        - const: Task
          type: string
        - const: Workload
          type: string
        - const: Deployment
          type: string
    shared_common_src_parameters_rs_ParameterType:
      oneOf:
        - const: string
          type: string
        - const: string_array
          type: string
        - const: integer
          type: string
        - const: decimal
          type: string
        - const: boolean
          type: string
        - const: date
          type: string
        - const: timestamp
          type: string
    app_dashboards_src_models_rs_ChartConfig:
      allOf:
        - additionalProperties:
            description: JSON value; fields depend on the enclosing document or provider.
          type: object
        - properties:
            colors:
              items:
                type: string
              type: array
            decimals:
              anyOf:
                - minimum: 0
                  type: integer
                - type: 'null'
            legend:
              type: boolean
            number_format:
              anyOf:
                - type: string
                - type: 'null'
            series_column:
              anyOf:
                - type: string
                - type: 'null'
            sort_column:
              anyOf:
                - type: string
                - type: 'null'
            sort_direction:
              anyOf:
                - type: string
                - type: 'null'
            stacked:
              type: boolean
            table_columns:
              items:
                type: string
              type: array
            thresholds:
              items:
                description: >-
                  JSON value; fields depend on the enclosing document or
                  provider.
              type: array
            x_column:
              anyOf:
                - type: string
                - type: 'null'
            x_label:
              anyOf:
                - type: string
                - type: 'null'
            y_columns:
              items:
                type: string
              type: array
            y_label:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - x_column
            - y_columns
            - series_column
            - legend
            - stacked
            - number_format
            - decimals
            - colors
            - x_label
            - y_label
            - sort_column
            - sort_direction
            - table_columns
            - thresholds
          type: object
    app_dashboards_src_models_rs_WidgetKind:
      oneOf:
        - const: Table
          type: string
        - const: Stat
          type: string
        - const: Line
          type: string
        - const: Area
          type: string
        - const: Bar
          type: string
        - const: StackedBar
          type: string
        - const: Pie
          type: string
        - const: Donut
          type: string
        - const: Scatter
          type: string
        - const: Markdown
          type: string
    app_dashboards_src_models_rs_WidgetLayout:
      properties:
        h:
          minimum: 0
          type: integer
        w:
          minimum: 0
          type: integer
        x:
          minimum: 0
          type: integer
        'y':
          minimum: 0
          type: integer
      required:
        - x
        - 'y'
        - w
        - h
      type: object
    shared_common_src_compute_rs_ComputeTuning:
      properties:
        batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        file_read_concurrency:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        input_prefetch_batches:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        native_parquet_scan:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            False always uses connector-produced Arrow batches. Omitted keeps
            the native Parquet capability enabled when the source can supply it
            safely.
        output_buffer_batches:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        query_memory_bytes:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        spill_bytes:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: >-
            Zero disables disk spill. The directory is controlled by the
            deployment.
        threads:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
      required:
        - threads
        - query_memory_bytes
        - batch_rows
        - write_batch_rows
        - write_parallelism
        - spill_bytes
        - output_buffer_batches
        - file_read_concurrency
        - input_prefetch_batches
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.