Cube Dev Deployments API

openapi: 3.2.0
info:
  title: Cube Dev Deployments API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 23 operation(s) read from 8 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Cube Dev has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 15
    documentation: 8
    pages-with-code: 8
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.cube.dev/reference/cli.md
  - https://docs.cube.dev/reference/control-plane-api
  - https://docs.cube.dev/reference/control-plane-api.md
  - https://docs.cube.dev/reference/core-data-apis/sql-api
  - https://docs.cube.dev/reference/core-data-apis/rest-api
  - https://docs.cube.dev/reference/embed-apis/generate-session
  - https://docs.cube.dev/reference/embed-apis/dashboard-comments
  - https://docs.cube.dev/reference/embed-apis/generate-session.md
servers:
- url: https://YOUR_CUBE_CLOUD_HOST
security:
- bearer: []
tags:
- name: Deployments
paths:
  /api/v1/deployments:
    get:
      operationId: get_api_v1_deployments
      tags:
      - Deployments
      summary: Get deployments
      x-source: https://docs.cube.dev/reference/cli.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/deployments/{deploymentid}/dashboard-exports:
    post:
      operationId: post_api_v1_deployments_deploymentid_dashboard_exports
      tags:
      - Deployments
      summary: POST /api/v1/deployments/{deploymentId}/dashboard-exports
      x-source: https://docs.cube.dev/reference/control-plane-api
      parameters:
      - name: deploymentid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1DeploymentsDeploymentidDashboardExportsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST  -H "Authorization: Bearer YOUR_API_KEY"  -H "Content-Type: application/json"  -d ''{"dashboardPublicId": "abc123", "format": "pdf"}''  "https://YOUR_CUBE_CLOUD_HOST/api/v1/deployments/123/dashboard-exports" '
  /api/v1/deployments/{deploymentid}/dashboard-exports/{jobid}:
    get:
      operationId: get_api_v1_deployments_deploymentid_dashboard_exports_jobid
      tags:
      - Deployments
      summary: GET /api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}
      x-source: https://docs.cube.dev/reference/control-plane-api
      parameters:
      - name: deploymentid
        in: path
        required: true
        schema:
          type: string
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl  -H "Authorization: Bearer YOUR_API_KEY"  "https://YOUR_CUBE_CLOUD_HOST/api/v1/deployments/123/dashboard-exports/JOB_ID" '
  /api/v1/deployments/{deploymentid}/dashboard-exports/{jobid}/download:
    get:
      operationId: get_api_v1_deployments_deploymentid_dashboard_exports_jobid_download
      tags:
      - Deployments
      summary: GET /api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}/download
      x-source: https://docs.cube.dev/reference/control-plane-api
      parameters:
      - name: deploymentid
        in: path
        required: true
        schema:
          type: string
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"Authorization: Bearer YOUR_API_KEY\"  -o dashboard.pdf  \"https://YOUR_CUBE_CLOUD_HOST/api/v1/deployments/123/dashboard-exports/JOB_ID/download\" \n An account administrator can also render the dashboard as if a specific other\nuser opened it — renderAs a console user or an embed user — so the file\nreflects that person’s own row-level security. An embed subject that doesn’t\nexist yet is provi"
  /api/v1/deployments/{deploymentid}/environments/{environmentid}/tokens-for-meta-sync:
    post:
      operationId: post_api_v1_deployments_deploymentid_environments_environmentid_tokens_for_meta_
      tags:
      - Deployments
      summary: POST /api/v1/deployments/{deploymentId}/environments/{environmentId}/tokens-for…
      x-source: https://docs.cube.dev/reference/control-plane-api
      parameters:
      - name: deploymentid
        in: path
        required: true
        schema:
          type: string
      - name: environmentid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1DeploymentsDeploymentidEnvironmentsEnvironmentidTok'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1DeploymentsDeploymentidEnvironmentsEnvironmentidTok2'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -X POST  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{ \n \"security_context\": {\"tenant_id\": \"acme\"}, \n \"expires_in\": 3600 \n }'  \"https://YOUR_CUBE_CLOUD_HOST/api/v1/deployments/123/environments/456/tokens-for-meta-sync\" \n Example response: \n { \n \"data\" : { \n \"token\" : \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\" , \n \"created_at\" : \"2024-01-15T10:30:00.000Z\" "
  /api/v1/deployments/{deploymentid}/{id}:
    get:
      operationId: get_api_v1_deployments_deploymentid_id
      tags:
      - Deployments
      summary: GET /api/v1/deployments/{deploymentId}/environments
      x-source: https://docs.cube.dev/reference/control-plane-api
      parameters:
      - name: deploymentid
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1DeploymentsDeploymentidIdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  -H \"Authorization: Bearer YOUR_API_KEY\"  \"https://YOUR_CUBE_CLOUD_HOST/api/v1/deployments/123/environments\" \n Example response: \n { \n \"data\" : { \n \"environments\" : [ \n { \n \"id\" : \"456\" , \n \"name\" : \"Production\" , \n \"type\" : \"production\" , \n \"api_credentials\" : { \n \"rest\" : { \n \"url\" : \"https://example.cubecloud.dev/cubejs-api\" \n }, \n \"sql\" : { \n \"host\" : \"example.sql.cubecloud.dev\" , \n \"port"
        collapsed_from: 2 example path(s) differing only at id
components:
  schemas:
    PostApiV1DeploymentsDeploymentidEnvironmentsEnvironmentidTok2:
      type: object
      properties:
        data:
          type: object
          properties:
            token:
              type: string
            created_at:
              type: string
              format: date-time
            expires_at:
              type: string
              format: date-time
            scopes:
              type: array
              items:
                type: string
    GetApiV1DeploymentsDeploymentidIdResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        api_credentials:
          type: object
          properties:
            rest:
              type: object
              properties:
                url:
                  type: string
            sql:
              type: object
              properties:
                host:
                  type: string
                port:
                  type: integer
    PostApiV1DeploymentsDeploymentidEnvironmentsEnvironmentidTok:
      type: object
      properties:
        security_context:
          type: object
          properties:
            tenant_id:
              type: string
        expires_in:
          type: integer
    PostApiV1DeploymentsDeploymentidDashboardExportsRequest:
      type: object
      properties:
        dashboardPublicId:
          type: string
        format:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer