> ## 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. # Import published package > Imports a published OCI-backed Akua package and registers its first immutable version. Akua verifies the supplied version metadata against the published artifact before durable registration. Requires published Package import access. ## OpenAPI ````yaml /openapi-public.json post /packages:import 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:import: post: tags: - Packages summary: Import published package description: >- Imports a published OCI-backed Akua package and registers its first immutable version. Akua verifies the supplied version metadata against the published artifact before durable registration. Requires published Package import access. operationId: packages.importPublished 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 - 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/ImportPackageBody' required: true responses: '201': description: Package imported content: application/json: schema: $ref: '#/components/schemas/Package' '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: ImportPackageBody: type: object properties: name: type: string minLength: 1 maxLength: 120 description: anyOf: - type: string maxLength: 1000 - type: 'null' display_image_url: type: string format: uri maxLength: 2048 oci_ref: type: string description: >- OCI reference for the published Akua Package repository. If this registry matches an active workspace registry credential, Akua uses that credential to inspect the artifact. minLength: 1 maxLength: 2048 pattern: ^oci:\/\/ version: $ref: '#/components/schemas/CreatePackageVersionOciBody' required: - name - oci_ref - version additionalProperties: false Package: type: object properties: id: type: string minLength: 1 maxLength: 54 html_url: type: string description: Absolute dashboard URL for this resource. OUTPUT_ONLY. examples: - https://akua.dev/packages/pkg_j572abc123def456 format: uri maxLength: 2048 workspace_id: type: string minLength: 1 maxLength: 53 name: type: string latest_version_id: type: string minLength: 1 maxLength: 55 description: anyOf: - type: string - type: 'null' display_image_url: anyOf: - type: string format: uri maxLength: 2048 - type: 'null' source: $ref: '#/components/schemas/PackageSource' composed_from_sources: anyOf: - type: array items: type: object - type: 'null' description: >- Source provenance used to create this Package (helm URLs, OCI refs, git source details). Only visible in `view=full`. created_at: type: integer minimum: 0 description: Unix timestamp (seconds) etag: type: string required: - id - html_url - workspace_id - name - latest_version_id - description - display_image_url - source - created_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 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 PackageSource: oneOf: - type: object properties: kind: type: string enum: - hosted repository_id: type: string description: platform-hosted repository that contains the package source minLength: 1 maxLength: 55 required: - kind - repository_id additionalProperties: false - type: object properties: kind: type: string enum: - oci oci_ref: type: string description: OCI reference to the package source (no digest) required: - kind - oci_ref 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.