> ## Documentation Index > Fetch the complete documentation index at: https://docs.cube.dev/llms.txt > Use this file to discover all available pages before exploring further. # Pause a report delivery In preview: ask Cube support to enable it. Its schedule stops firing until it is resumed; a run can still be started by hand. Pausing a paused delivery changes nothing. ## OpenAPI ````yaml /api-reference/api.yaml post /api/v1/deployments/{deploymentId}/report-deliveries/{id}/pause openapi: 3.1.0 info: title: Cube Platform API version: 1.0.0 description: >- Programmatically manage Cube: deployments and everything scoped to them (environments, folders, reports, workbooks, notifications, workspace, and agents), plus account-level users, groups, policies, embedding, and AI settings. Data-model authoring, dev mode, branches, and uploads live under /build/api/v1 — same host and token, routed to the build pods. servers: - url: https://{tenant}.cubecloud.dev description: Your tenant host. Replace the whole host if you use a custom domain. variables: tenant: default: your-tenant description: Your Cube tenant subdomain security: - bearerAuth: [] tags: - name: Deployments - name: Deployment Creation - name: Environments - name: Env Variables - name: Regions - name: Data Model - name: Data Model Uploads - name: GitHub - name: GitHub Connection - name: dbt Sync - name: Databricks Metric View Publication - name: Databricks Metric View Integration - name: Snowflake Semantic View Sync - name: Folders - name: Reports - name: External Documents - name: Workbooks - name: Workbook Promotions - name: Dashboard Exports - name: Notifications - name: Scheduled Tasks - name: Workspace - name: Agents - name: Users - name: Users Admin - name: API Keys - name: User Attributes - name: User Attribute Values - name: Tenant Settings - name: OAuth Integrations - name: User OAuth Tokens - name: OIDC Token Configs - name: App Theme - name: Embed - name: Embed Tenants - name: Dashboard Embed Access - name: Usage Analytics - name: OpenAPI Spec - name: Report Deliveries paths: /api/v1/deployments/{deploymentId}/report-deliveries/{id}/pause: post: tags: - Report Deliveries summary: Pause a report delivery operationId: pauseReportDelivery parameters: - in: path name: deploymentId required: true schema: type: integer description: Numeric id of the deployment that owns the delivery. - in: path name: id required: true schema: type: integer description: Numeric id of the report delivery. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportDeliveryResponse' description: '' components: schemas: ReportDeliveryResponse: properties: deploymentId: type: integer destination: $ref: '#/components/schemas/ReportDeliveryDestination' id: type: integer lastRunAt: oneOf: - format: date-time type: string - type: 'null' description: When the last run finished. `null` before the first. lastSuccessAt: oneOf: - format: date-time type: string - type: 'null' description: When the last successful run finished. `null` if none has succeeded. name: type: string nextRunAt: oneOf: - {} - type: 'null' description: >- When the schedule next fires. `null` when there is no schedule or it is paused. notifications: $ref: '#/components/schemas/ReportDeliveryNotificationSettings' description: >- How the owner hears that the delivery failed or recovered. A delivery that runs more than once a day reports only changes in its status; a daily or rarer one reports every failed run. ownerUserId: oneOf: - type: integer - type: 'null' description: >- The accountable user, whose Google account writes the sheet. `null` once that user has been deleted. pausedAt: oneOf: - {} - type: 'null' description: When the delivery was paused. `null` if it is not. reportId: oneOf: - type: integer - type: 'null' description: The delivered report. `null` once that report has been deleted. reportName: oneOf: - type: string - type: 'null' description: >- Name of the delivered report. `null` once that report has been deleted. reportPublicId: oneOf: - type: string - type: 'null' description: >- Public id of the delivered report. `null` once that report has been deleted. reportWorkbookId: oneOf: - type: integer - type: 'null' description: >- Workbook holding the delivered report. `null` once that report has been deleted. runAsUserId: oneOf: - type: integer - type: 'null' description: >- The user whose data access the query runs with. `null` once that user has been deleted. runningSince: oneOf: - format: date-time type: string - type: 'null' description: >- When the run still in progress started. `null` while no run is going. schedule: oneOf: - $ref: '#/components/schemas/ReportDeliverySchedule' - type: 'null' description: '`null` for a delivery that runs only on request.' shape: oneOf: - $ref: '#/components/schemas/ReportDeliveryShape' - type: 'null' description: '`null` when every column is delivered as is.' sheetTitle: oneOf: - type: string - type: 'null' description: >- Current title of the destination tab, read from Google at most every few minutes. `null` for a `new_sheet` delivery, or before its title has been read. spreadsheetTitle: oneOf: - type: string - type: 'null' description: >- Title of the destination spreadsheet, read from Google at most every few minutes and by each run. `null` before then. status: $ref: '#/components/schemas/ReportDeliveryResponseStatus' writeMode: $ref: '#/components/schemas/ReportDeliveryResponseWriteMode' required: - id - deploymentId - name - destination - writeMode - notifications - status type: object ReportDeliveryDestination: properties: anchorCell: description: Top-left cell of the delivered block, in A1 notation. type: string sheetId: oneOf: - type: integer - type: 'null' sheetName: oneOf: - type: string - type: 'null' spreadsheetId: type: string required: - spreadsheetId - anchorCell type: object ReportDeliveryNotificationSettings: properties: email: type: boolean inbox: type: boolean slackChannelId: oneOf: - type: string - type: 'null' description: '`null` when nothing is posted to Slack.' slackChannelName: oneOf: - type: string - type: 'null' required: - inbox - email type: object ReportDeliverySchedule: properties: cronExpressions: items: type: string type: array timezone: type: string required: - cronExpressions - timezone type: object ReportDeliveryShape: properties: columns: items: $ref: '#/components/schemas/ReportDeliveryColumn' type: array required: - columns type: object ReportDeliveryResponseStatus: enum: - active - failing - needs_reconnect - orphaned type: string ReportDeliveryResponseWriteMode: enum: - overwrite - append - new_sheet type: string ReportDeliveryColumn: properties: column: oneOf: - type: string - type: 'null' header: oneOf: - type: string - type: 'null' placeholder: oneOf: - type: boolean - type: 'null' type: object securitySchemes: bearerAuth: type: http scheme: bearer description: 'Token authentication. Send `Authorization: Bearer `.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.