> ## Documentation Index > Fetch the complete documentation index at: https://docs.akua.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create dashboard > Creates a dashboard in the workspace, optionally with an ordered set of initial snippet widgets. Blank dashboards remain valid. ## OpenAPI ````yaml /openapi-public.json post /dashboards openapi: 3.1.0 info: title: Akua API version: 1.0.0 description: >- Public API for managing Akua workspaces, clusters, products, and installs. Authenticate with a workspace API token via the `Authorization: Bearer sk_akua_...` header. A workspace-owned token implies its workspace. Broad tokens select the active workspace via the optional `Akua-Context` header. contact: name: Akua API support email: support@akua.dev url: https://akua.dev/docs servers: - url: https://api.akua.dev/v1 description: Production security: [] tags: - name: Auth description: Authentication and token management. - name: Agent events description: Persisted agent transcripts and response recovery. - name: Custom domains description: Workspace custom domains and routing targets. - name: Cloudflare description: Cloudflare account credentials and gateway control. - name: Clusters description: Kubernetes clusters and cluster access operations. - name: ComputeConfigs description: Workspace compute provider configurations. - name: Entitlements description: Effective workspace capabilities and limits. - name: Dashboards description: Dashboard and widget resources. - name: Installs description: Installation and render operations. - name: Machines description: Compute machines and lifecycle events. - name: Notifications description: User notification state. - name: Offer Channels description: Private offer channels and policy versions. - name: Offers description: Marketplace offers and redemption tracking. - name: Operations description: Long-running operation status and controls. - name: Order Drafts description: Draft checkout orders and checkout sessions. - name: Organizations description: Organizations, memberships, and managed workspaces. - name: Packages description: Software packages, versions, and input schemas. - name: Products description: Marketplace product catalog resources. - name: Preview hostnames description: Install preview hostnames and routing state. - name: Quotas description: Workspace quota limits and usage. - name: Regions description: Available deployment regions. - name: Registry description: Container registry credentials and repositories. - name: Repository change requests description: Fork-backed repository change reviews and lifecycle actions. - name: Repositories description: Source repositories available to the workspace. - name: Secrets description: Workspace secrets and secret versions. - name: Snippets description: Reusable snippets and snippet runs. - name: Workspace subdomains description: Workspace subdomain identity. - name: Workspaces description: Workspace resources, members, and billing state. paths: /dashboards: post: tags: - Dashboards summary: Create dashboard description: >- Creates a dashboard in the workspace, optionally with an ordered set of initial snippet widgets. Blank dashboards remain valid. operationId: dashboards.create parameters: - name: akua-context in: header schema: type: string minLength: 1 maxLength: 53 description: >- Optional workspace/scope context for the request. Carries a single workspace wire id (`ws_…`) today. Only needed for broad tokens - a workspace-owned token implies its workspace. examples: - ws_j572abc123def456 required: false requestBody: content: application/json: schema: type: object properties: name: type: string examples: - Cluster Overview minLength: 1 maxLength: 100 description: type: string maxLength: 500 widgets: type: array items: oneOf: - type: object properties: snippet_id: type: string minLength: 1 maxLength: 54 title: type: string maxLength: 100 display_type: type: string enum: - table - stat - json - logs - timeseries description: >- Controls how the snippet result is rendered in dashboard widgets col_span: type: number enum: - 1 - 2 - 3 - 4 default: 2 required: - snippet_id additionalProperties: false - type: object properties: widget_type: type: string enum: - snippet snippet_id: type: string minLength: 1 maxLength: 54 snippet_etag: anyOf: - type: string - type: 'null' default: null title: type: string maxLength: 100 col_span: type: number enum: - 1 - 2 - 3 - 4 default: 2 height: type: string enum: - compact - standard - tall default: standard drill_down: anyOf: - type: string minLength: 1 maxLength: 2048 - type: 'null' default: null visualization_options: type: object default: {} freshness_policy: oneOf: - type: object properties: mode: type: string enum: - provider_default required: - mode additionalProperties: false - type: object properties: mode: type: string enum: - max_age max_age_seconds: type: integer minimum: 30 maximum: 86400 required: - mode - max_age_seconds additionalProperties: false default: mode: provider_default input_bindings: type: object additionalProperties: oneOf: - type: object properties: mode: type: string enum: - inherit filter_key: anyOf: - type: string enum: - time - comparison - cluster - install - product - package - region - status - type: string pattern: ^var\.[a-z][a-z0-9_]{0,31}$ required: - mode - filter_key additionalProperties: false - type: object properties: mode: type: string enum: - fixed value: {} required: - mode - value additionalProperties: false - type: object properties: mode: type: string enum: - unbound required: - mode additionalProperties: false default: {} visualization: anyOf: - type: string enum: - stat - sparkline - line - area - bar - donut - table - status_list - logs - json - type: 'null' default: null refresh_policy: oneOf: - type: object properties: mode: type: string enum: - on_load required: - mode additionalProperties: false - type: object properties: mode: type: string enum: - manual required: - mode additionalProperties: false - type: object properties: mode: type: string enum: - interval interval_seconds: type: integer minimum: 60 maximum: 86400 required: - mode - interval_seconds additionalProperties: false default: mode: on_load display_type: anyOf: - type: string enum: - table - stat - json - logs - timeseries - type: 'null' description: >- Controls how the snippet result is rendered in dashboard widgets default: null required: - widget_type - snippet_id additionalProperties: false - type: object properties: widget_type: type: string enum: - platform_metric metric_key: type: string minLength: 1 maxLength: 100 pattern: ^[a-z][a-z0-9_]*$ metric_version: type: integer exclusiveMinimum: 0 filter_bindings: type: object additionalProperties: oneOf: - type: object properties: mode: type: string enum: - inherit filter_key: anyOf: - type: string enum: - time - comparison - cluster - install - product - package - region - status - type: string pattern: ^var\.[a-z][a-z0-9_]{0,31}$ required: - mode - filter_key additionalProperties: false - type: object properties: mode: type: string enum: - fixed value: {} required: - mode - value additionalProperties: false - type: object properties: mode: type: string enum: - unbound required: - mode additionalProperties: false default: {} title: type: string maxLength: 100 col_span: type: number enum: - 1 - 2 - 3 - 4 default: 2 height: type: string enum: - compact - standard - tall default: standard drill_down: anyOf: - type: string minLength: 1 maxLength: 2048 - type: 'null' default: null visualization_options: type: object default: {} freshness_policy: oneOf: - type: object properties: mode: type: string enum: - provider_default required: - mode additionalProperties: false - type: object properties: mode: type: string enum: - max_age max_age_seconds: type: integer minimum: 30 maximum: 86400 required: - mode - max_age_seconds additionalProperties: false default: mode: provider_default required: - widget_type - metric_key - metric_version additionalProperties: false x-platform-exact-union: true maxItems: 24 required: - name additionalProperties: false required: true responses: '201': description: Dashboard created content: application/json: schema: type: object properties: dashboard_id: type: string required: - dashboard_id additionalProperties: false '401': description: Missing, invalid or expired credential. content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorized' '403': description: The credential may not act in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiForbidden' '409': description: >- The request conflicts with existing resource state or immutable intent. content: application/json: schema: $ref: '#/components/schemas/ApiConflict' '422': description: The request is well-formed but cannot be processed. content: application/json: schema: $ref: '#/components/schemas/ApiUnprocessable' security: - BearerAuth: [] components: schemas: ApiUnauthorized: type: object properties: _tag: type: string enum: - Unauthorized success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiForbidden: type: object properties: _tag: type: string enum: - Forbidden success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiConflict: type: object properties: _tag: type: string enum: - Conflict success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiUnprocessable: type: object properties: _tag: type: string enum: - Unprocessable success: type: boolean enum: - false errors: type: array prefixItems: - $ref: '#/components/schemas/ApiErrorEntry' minItems: 1 items: $ref: '#/components/schemas/ApiErrorEntry' result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false ApiErrorEntry: type: object properties: code: type: integer description: Machine-readable error code examples: - 7002 message: type: string description: Human-readable error message examples: - Resource not found path: type: array items: type: string description: Field path that caused the error, when applicable examples: - - body - name metadata: type: object additionalProperties: type: string required: - code - message additionalProperties: false securitySchemes: BearerAuth: description: >- workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.