> ## 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 package version > Registers an immutable version for an existing Package. OCI-backed Packages verify the supplied version metadata against the published artifact before durable registration. Hosted Packages publish the immutable version from an authored repository while preserving the Package, Products, Offers, and existing Installs. ## OpenAPI ````yaml /openapi-public.json post /packages/{id}/versions 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: /packages/{id}/versions: post: tags: - Packages summary: Create package version description: >- Registers an immutable version for an existing Package. OCI-backed Packages verify the supplied version metadata against the published artifact before durable registration. Hosted Packages publish the immutable version from an authored repository while preserving the Package, Products, Offers, and existing Installs. operationId: packages.createVersion parameters: - name: id in: path schema: type: string description: Package ID examples: - pkg_j572abc123def456 minLength: 1 maxLength: 54 required: true - 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 - name: idempotency-key in: header schema: type: string minLength: 1 maxLength: 64 description: >- Optional caller-supplied idempotency key. Any non-empty key up to 64 characters is accepted. Endpoint-specific documentation describes how the key is used. examples: - create-prod-2026-05-07 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePackageVersionBody' required: true responses: '201': description: Package version created content: application/json: schema: $ref: '#/components/schemas/PackageVersion' '202': description: Hosted package version publication accepted content: application/json: schema: $ref: '#/components/schemas/Operation' '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' '404': description: The resource was not found in this workspace. content: application/json: schema: $ref: '#/components/schemas/ApiNotFound' '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: CreatePackageVersionBody: anyOf: - $ref: '#/components/schemas/CreatePackageVersionOciBody' - $ref: '#/components/schemas/CreateHostedPackageVersionBody' PackageVersion: type: object properties: id: type: string minLength: 1 maxLength: 55 package_id: type: string minLength: 1 maxLength: 54 semver: type: string minLength: 1 maxLength: 128 pattern: >- ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$ ref: type: string input_schema: type: object published_at: type: integer minimum: 0 description: Unix timestamp (seconds) created_at: type: integer minimum: 0 description: Unix timestamp (seconds) etag: type: string required: - id - package_id - semver - ref - input_schema - published_at - created_at additionalProperties: false Operation: type: object properties: id: type: string minLength: 1 maxLength: 53 workspace_id: anyOf: - type: string minLength: 1 maxLength: 53 - type: 'null' organization_id: anyOf: - type: string minLength: 1 maxLength: 54 - type: 'null' owner_type: type: string enum: - install - repository_change_request - repository - workspace - machine - cluster - package description: Domain entity collection the operation acts on. owner_id: type: string description: >- Prefixed ID of the entity this operation acts on. Prefix matches `owner_type` (`ws_`, `mch_`, `clu_`, `pkg_`, `inst_`, `rcr_`, `repo_`). parent_operation_id: anyOf: - type: string minLength: 1 maxLength: 53 - type: 'null' description: ID of the chained parent operation, when present. state: type: string enum: - RUNNING - SUCCEEDED - FAILED - CANCELLED description: Lifecycle state. Past-participle terminal states per AIP-216. done: type: boolean description: True iff state is a terminal value. html_url: type: string description: >- Deep link to the dashboard view of this operation's owning resource when available, otherwise the operation detail page. examples: - https://akua.dev/installs/inst_j572abc123def456?tab=operations format: uri maxLength: 2048 metadata: $ref: '#/components/schemas/OperationMetadata' response: $ref: '#/components/schemas/OperationResponse' error: anyOf: - type: object properties: code: type: integer message: type: string required: - message additionalProperties: false - type: 'null' description: Populated when `state` is `FAILED` or `CANCELLED`. last_error: anyOf: - type: object properties: message: type: string step_name: type: string required: - message additionalProperties: false - type: 'null' description: >- Latest error from any failed step. Populated even mid-flight; cleared when the step succeeds on retry. started_at: type: integer minimum: 0 description: Unix timestamp (seconds) completed_at: anyOf: - type: integer minimum: 0 - type: 'null' description: Unix timestamp (seconds) steps: type: array items: $ref: '#/components/schemas/OperationStep' required: - id - workspace_id - organization_id - owner_type - owner_id - parent_operation_id - state - done - html_url - metadata - response - error - last_error - started_at - completed_at additionalProperties: false 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 ApiNotFound: type: object properties: _tag: type: string enum: - NotFound 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 CreatePackageVersionOciBody: type: object properties: semver: type: string examples: - 1.2.3 minLength: 1 maxLength: 128 pattern: >- ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$ ref: type: string description: >- Immutable package content reference. For OCI-backed packages this is normally the digest returned by `akua publish`; Akua verifies it against the published artifact before registering the version. minLength: 1 maxLength: 512 input_schema: allOf: - $ref: '#/components/schemas/PackageVersionInputs' - description: >- JSON Schema exported from the Akua package version. Used to render future install forms; Akua verifies it against the published artifact before registering the version. compatibility: type: object properties: clusterTypes: type: array items: type: string kubernetes: type: object properties: minVersion: type: string maxVersion: type: string additionalProperties: false placement: type: object properties: providers: anyOf: - type: string enum: - any - type: array items: type: string regions: anyOf: - type: string enum: - any - type: array items: type: string required: - providers - regions additionalProperties: false kaas: type: object properties: networkProfile: type: string enum: - linux_cilium - mixed_os_calico required: - networkProfile additionalProperties: false required: - clusterTypes - kubernetes - placement additionalProperties: false required: - semver - ref - input_schema additionalProperties: false CreateHostedPackageVersionBody: type: object properties: source: type: object properties: repository_id: type: string minLength: 1 maxLength: 55 ref: type: string description: >- Immutable lowercase 40-character commit SHA in the authored workspace repository. Akua validates that exact checkout and reads its package version from akua.toml. pattern: ^[0-9a-f]{40}$ required: - repository_id - ref additionalProperties: false required: - source additionalProperties: false OperationMetadata: oneOf: - type: object properties: type: type: string enum: - machine.create workspace_id: type: string minLength: 1 maxLength: 53 cluster_id: type: string minLength: 1 maxLength: 54 compute_config_id: type: string minLength: 1 maxLength: 54 instance_type: type: string managed: type: boolean request_fingerprint: type: string minLength: 1 required: - type - workspace_id - cluster_id - instance_type - managed - request_fingerprint additionalProperties: false - type: object properties: type: type: string enum: - machine.delete workspace_id: type: string minLength: 1 maxLength: 53 machine_id: type: string minLength: 1 maxLength: 54 request_fingerprint: type: string minLength: 1 required: - type - workspace_id - machine_id - request_fingerprint additionalProperties: false - type: object properties: type: type: string enum: - machine.suspend workspace_id: type: string minLength: 1 maxLength: 53 machine_id: type: string minLength: 1 maxLength: 54 request_fingerprint: type: string minLength: 1 required: - type - workspace_id - machine_id - request_fingerprint additionalProperties: false - type: object properties: type: type: string enum: - machine.resume workspace_id: type: string minLength: 1 maxLength: 53 machine_id: type: string minLength: 1 maxLength: 54 request_fingerprint: type: string minLength: 1 required: - type - workspace_id - machine_id - request_fingerprint additionalProperties: false - type: object properties: type: type: string enum: - cluster.delete cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.create workspace_id: type: string minLength: 1 maxLength: 53 region_id: type: string minLength: 1 maxLength: 54 name: type: string cluster_id: type: string description: >- ID of the new cluster. Set once the cluster record exists, before provisioning finishes. minLength: 1 maxLength: 54 required: - type - workspace_id - region_id - name additionalProperties: false - type: object properties: type: type: string enum: - cluster.suspend cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.resume cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.capabilities.refresh cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.capability.ensure cluster_id: type: string minLength: 1 maxLength: 54 capability: type: string minLength: 1 required: - type - cluster_id - capability additionalProperties: false - type: object properties: type: type: string enum: - cluster.worker_bootstrap.revoke cluster_id: type: string minLength: 1 maxLength: 54 worker_bootstrap_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id - worker_bootstrap_id additionalProperties: false - type: object properties: type: type: string enum: - install.create idempotency_key: type: string workspace_id: type: string minLength: 1 maxLength: 53 product_id: type: string minLength: 1 maxLength: 55 required: - type - idempotency_key - workspace_id additionalProperties: false - type: object properties: type: type: string enum: - install.render install_id: type: string minLength: 1 maxLength: 55 trigger_commit_sha: type: string required: - type - install_id additionalProperties: false - type: object properties: type: type: string enum: - install.delete install_id: type: string minLength: 1 maxLength: 55 required: - type - install_id additionalProperties: false - type: object properties: type: type: string enum: - preview_hostname.bind_pinned install_id: type: string minLength: 1 maxLength: 55 render_id: type: string minLength: 1 maxLength: 54 protocol: type: string enum: - http - websocket - grpc routing_mode: type: string enum: - through_dispatcher - bypass_dispatcher idempotency_key: type: string required: - type - install_id - render_id - protocol - routing_mode - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - preview_hostname.bind_floating install_id: type: string minLength: 1 maxLength: 55 track: type: string minLength: 1 maxLength: 100 render_id: type: string minLength: 1 maxLength: 54 protocol: type: string enum: - http - websocket - grpc routing_mode: type: string enum: - through_dispatcher - bypass_dispatcher idempotency_key: type: string required: - type - install_id - track - render_id - protocol - routing_mode - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - preview_hostname.delete install_id: type: string minLength: 1 maxLength: 55 preview_hostname_id: type: string minLength: 1 maxLength: 54 if_match: type: string idempotency_key: type: string required: - type - install_id - preview_hostname_id - if_match - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - workspace.delete workspace_id: type: string minLength: 1 maxLength: 53 required: - type - workspace_id additionalProperties: false - type: object properties: type: type: string enum: - workspace.subscription.cancel workspace_id: type: string minLength: 1 maxLength: 53 mode: type: string enum: - period_end required: - type - workspace_id - mode additionalProperties: false - type: object properties: type: type: string enum: - workspace.subdomain.set_name workspace_id: type: string minLength: 1 maxLength: 53 name: type: string minLength: 1 maxLength: 63 idempotency_key: type: string required: - type - workspace_id - name - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - custom_domain.create workspace_id: type: string minLength: 1 maxLength: 53 hostname: type: string minLength: 1 maxLength: 253 target: oneOf: - type: object properties: kind: type: string enum: - install install_id: type: string minLength: 1 maxLength: 55 required: - kind - install_id additionalProperties: false - type: object properties: kind: type: string enum: - cluster cluster_id: type: string minLength: 1 maxLength: 54 required: - kind - cluster_id additionalProperties: false - type: object properties: kind: type: string enum: - external endpoint: type: string format: uri mtls_secret_id: type: string minLength: 1 maxLength: 54 required: - kind - endpoint additionalProperties: false protocol: type: string enum: - http - websocket - grpc routing_mode: type: string enum: - through_dispatcher - bypass_dispatcher idempotency_key: type: string required: - type - workspace_id - hostname - target - protocol - routing_mode - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - custom_domain.update workspace_id: type: string minLength: 1 maxLength: 53 custom_domain_id: type: string minLength: 1 maxLength: 54 target: oneOf: - type: object properties: kind: type: string enum: - install install_id: type: string minLength: 1 maxLength: 55 required: - kind - install_id additionalProperties: false - type: object properties: kind: type: string enum: - cluster cluster_id: type: string minLength: 1 maxLength: 54 required: - kind - cluster_id additionalProperties: false - type: object properties: kind: type: string enum: - external endpoint: type: string format: uri mtls_secret_id: type: string minLength: 1 maxLength: 54 required: - kind - endpoint additionalProperties: false protocol: type: string enum: - http - websocket - grpc routing_mode: type: string enum: - through_dispatcher - bypass_dispatcher if_match: type: string idempotency_key: type: string required: - type - workspace_id - custom_domain_id - if_match - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - custom_domain.delete workspace_id: type: string minLength: 1 maxLength: 53 custom_domain_id: type: string minLength: 1 maxLength: 54 if_match: type: string idempotency_key: type: string required: - type - workspace_id - custom_domain_id - if_match - idempotency_key additionalProperties: false - type: object properties: type: type: string enum: - cloudflare.private_origin_route.prepare workspace_id: type: string minLength: 1 maxLength: 53 cluster_id: type: string minLength: 1 maxLength: 54 route_intent_id: type: string minLength: 1 maxLength: 54 required: - type - workspace_id - cluster_id - route_intent_id additionalProperties: false - type: object properties: type: type: string enum: - cloudflare.private_origin_route.release workspace_id: type: string minLength: 1 maxLength: 53 route_intent_id: type: string minLength: 1 maxLength: 54 required: - type - workspace_id - route_intent_id additionalProperties: false - type: object properties: type: type: string enum: - package.create idempotency_key: type: string workspace_id: type: string minLength: 1 maxLength: 53 name: type: string required: - type - idempotency_key - workspace_id - name additionalProperties: false - type: object properties: type: type: string enum: - package.version.publish_hosted idempotency_key: type: string workspace_id: type: string minLength: 1 maxLength: 53 package_id: type: string minLength: 1 maxLength: 54 request_fingerprint: type: string minLength: 1 required: - type - idempotency_key - workspace_id - package_id - request_fingerprint additionalProperties: false - type: object properties: type: type: string enum: - package.version.publish_local_chart idempotency_key: type: string workspace_id: type: string minLength: 1 maxLength: 53 package_id: type: string minLength: 1 maxLength: 54 required: - type - idempotency_key - workspace_id - package_id additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.create workspace_id: type: string minLength: 1 maxLength: 53 parent_repository_id: type: string minLength: 1 maxLength: 55 created_by_kind: type: string enum: - agent - wizard - user required: - type - workspace_id - parent_repository_id - created_by_kind additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.accept repository_change_request_id: type: string minLength: 1 maxLength: 54 user_id: type: string required: - type - repository_change_request_id - user_id additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.reject repository_change_request_id: type: string minLength: 1 maxLength: 54 user_id: type: string reason: type: string required: - type - repository_change_request_id - user_id - reason additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.withdraw repository_change_request_id: type: string minLength: 1 maxLength: 54 user_id: type: string required: - type - repository_change_request_id - user_id additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.expire repository_change_request_id: type: string minLength: 1 maxLength: 54 required: - type - repository_change_request_id additionalProperties: false - type: object properties: type: type: string enum: - repository.delete repository_id: type: string minLength: 1 maxLength: 55 required: - type - repository_id additionalProperties: false OperationResponse: anyOf: - type: object properties: type: type: string enum: - machine.create machine_id: type: string minLength: 1 maxLength: 54 provider_id: type: string required: - type - machine_id - provider_id additionalProperties: false - type: object properties: type: type: string enum: - machine.delete machine_id: type: string minLength: 1 maxLength: 54 required: - type - machine_id additionalProperties: false - type: object properties: type: type: string enum: - machine.suspend machine_id: type: string minLength: 1 maxLength: 54 suspension_id: type: string minLength: 1 maxLength: 54 required: - type - machine_id - suspension_id additionalProperties: false - type: object properties: type: type: string enum: - machine.resume machine_id: type: string minLength: 1 maxLength: 54 required: - type - machine_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.delete cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.create cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.suspend cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.resume cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.capabilities.refresh cluster_id: type: string minLength: 1 maxLength: 54 required: - type - cluster_id additionalProperties: false - type: object properties: type: type: string enum: - cluster.capability.ensure cluster_id: type: string minLength: 1 maxLength: 54 capability: type: string minLength: 1 required: - type - cluster_id - capability additionalProperties: false - type: object properties: type: type: string enum: - cluster.worker_bootstrap.revoke note: type: string required: - type additionalProperties: false - type: object properties: type: type: string enum: - install.create install_id: type: string minLength: 1 maxLength: 55 argo_app_name: type: string argo_app_namespace: type: string required: - type - install_id - argo_app_name - argo_app_namespace additionalProperties: false - type: object properties: type: type: string enum: - install.create install_id: type: string minLength: 1 maxLength: 55 sandbox_skipped: type: boolean enum: - true required: - type - install_id - sandbox_skipped additionalProperties: false - type: object properties: type: type: string enum: - install.render install_render_id: type: string minLength: 1 maxLength: 54 repository_id: type: string minLength: 1 maxLength: 55 commit_sha: type: string render_hash: type: string skipped: type: boolean required: - type - install_render_id - repository_id - render_hash - skipped additionalProperties: false - type: object properties: type: type: string enum: - install.delete argo_app_deleted: type: boolean repo_purged: type: boolean required: - type - argo_app_deleted - repo_purged additionalProperties: false - type: object properties: type: type: string enum: - preview_hostname.bind_pinned install_id: type: string minLength: 1 maxLength: 55 preview_hostname_id: type: string minLength: 1 maxLength: 54 hostname: type: string minLength: 1 maxLength: 253 required: - type - install_id - preview_hostname_id - hostname additionalProperties: false - type: object properties: type: type: string enum: - preview_hostname.bind_floating install_id: type: string minLength: 1 maxLength: 55 preview_hostname_id: type: string minLength: 1 maxLength: 54 hostname: type: string minLength: 1 maxLength: 253 required: - type - install_id - preview_hostname_id - hostname additionalProperties: false - type: object properties: type: type: string enum: - preview_hostname.delete install_id: type: string minLength: 1 maxLength: 55 preview_hostname_id: type: string minLength: 1 maxLength: 54 hostname: type: string minLength: 1 maxLength: 253 required: - type - install_id - preview_hostname_id - hostname additionalProperties: false - type: object properties: type: type: string enum: - workspace.delete workspace_id: type: string minLength: 1 maxLength: 53 required: - type - workspace_id additionalProperties: false - type: object properties: type: type: string enum: - workspace.subscription.cancel subscription_id: type: string cancel_at: type: integer minimum: 0 description: Unix timestamp (seconds) required: - type - subscription_id - cancel_at additionalProperties: false - type: object properties: type: type: string enum: - workspace.subdomain.set_name workspace_id: type: string minLength: 1 maxLength: 53 workspace_subdomain_id: type: string minLength: 1 maxLength: 54 fqdn: type: string minLength: 1 maxLength: 253 required: - type - workspace_id - workspace_subdomain_id - fqdn additionalProperties: false - type: object properties: type: type: string enum: - custom_domain.create workspace_id: type: string minLength: 1 maxLength: 53 custom_domain_id: type: string minLength: 1 maxLength: 54 hostname: type: string minLength: 1 maxLength: 253 required: - type - workspace_id - custom_domain_id - hostname additionalProperties: false - type: object properties: type: type: string enum: - custom_domain.update workspace_id: type: string minLength: 1 maxLength: 53 custom_domain_id: type: string minLength: 1 maxLength: 54 hostname: type: string minLength: 1 maxLength: 253 required: - type - workspace_id - custom_domain_id - hostname additionalProperties: false - type: object properties: type: type: string enum: - custom_domain.delete workspace_id: type: string minLength: 1 maxLength: 53 custom_domain_id: type: string minLength: 1 maxLength: 54 hostname: type: string minLength: 1 maxLength: 253 required: - type - workspace_id - custom_domain_id - hostname additionalProperties: false - type: object properties: type: type: string enum: - cloudflare.private_origin_route.prepare origin_route_id: type: string minLength: 1 maxLength: 54 required: - type - origin_route_id additionalProperties: false - type: object properties: type: type: string enum: - cloudflare.private_origin_route.release route_intent_id: type: string minLength: 1 maxLength: 54 required: - type - route_intent_id additionalProperties: false - type: object properties: type: type: string enum: - package.create package_id: type: string minLength: 1 maxLength: 54 package_version_id: type: string minLength: 1 maxLength: 55 repository_id: type: string minLength: 1 maxLength: 55 required: - type - package_id - package_version_id - repository_id additionalProperties: false - type: object properties: type: type: string enum: - package.version.publish_hosted package_version_id: type: string minLength: 1 maxLength: 55 required: - type - package_version_id additionalProperties: false - type: object properties: type: type: string enum: - package.version.publish_local_chart package_version_id: type: string minLength: 1 maxLength: 55 required: - type - package_version_id additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.create repository_change_request_id: type: string minLength: 1 maxLength: 54 fork_repository_id: type: string minLength: 1 maxLength: 55 expires_at: type: integer minimum: 0 description: Unix timestamp (seconds) required: - type - repository_change_request_id - fork_repository_id - expires_at additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.accept merged_at: type: integer minimum: 0 description: Unix timestamp (seconds) triggered_install_render: type: boolean required: - type - merged_at - triggered_install_render additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.reject rejected_at: type: integer minimum: 0 description: Unix timestamp (seconds) required: - type - rejected_at additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.withdraw withdrawn_at: type: integer minimum: 0 description: Unix timestamp (seconds) required: - type - withdrawn_at additionalProperties: false - type: object properties: type: type: string enum: - repository_change_request.expire expired: type: boolean required: - type - expired additionalProperties: false - type: object properties: type: type: string enum: - repository.delete purged_at: type: integer minimum: 0 description: Unix timestamp (seconds) required: - type - purged_at additionalProperties: false - type: 'null' description: >- Populated only when `done && state === "SUCCEEDED"`. Discriminated by `type`. OperationStep: type: object properties: name: type: string description: User-visible milestone name. status: type: string enum: - pending - running - completed - failed - skipped description: Step lifecycle state. execution_type: type: string enum: - system - user - approval - skipped description: >- Step execution kind. `user`/`approval` mean the workflow is blocked on a human action. Internal bookkeeping steps are filtered from public responses. started_at: type: integer minimum: 0 description: Unix timestamp (seconds) completed_at: anyOf: - type: integer minimum: 0 - type: 'null' description: Unix timestamp (seconds) error_message: anyOf: - type: string - type: 'null' retryable: type: boolean skippable: type: boolean required: - name - status - execution_type - started_at - completed_at - error_message - retryable - skippable 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 PackageVersionInputs: type: object 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.