> ## 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.

# Get install details

> Returns current install metadata.



## OpenAPI

````yaml /openapi-public.json get /installs/{id}
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: Agents
    description: Agent identities and configuration.
  - name: Agent sessions
    description: Durable agent conversations and tasks.
  - name: Agent turns
    description: Submitted agent work and event emission.
  - name: Agent events
    description: Normalized agent event history and streams.
  - 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:
  /installs/{id}:
    get:
      tags:
        - Installs
      summary: Get install details
      description: Returns current install metadata.
      operationId: installs.get
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 55
            description: Install ID
            example: inst_j572abc123def456
          required: true
          description: Install ID
          name: id
          in: path
        - 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.
            example: ws_j572abc123def456
          required: false
          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.
          name: akua-context
          in: header
      responses:
        '200':
          description: Install details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Install'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    Install:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 55
        html_url:
          type: string
          maxLength: 2048
          format: uri
          description: Absolute dashboard URL for this resource. OUTPUT_ONLY.
          example: https://akua.dev/installs/inst_j572abc123def456
        workspace_id:
          type: string
          minLength: 1
          maxLength: 53
        customer_workspace:
          $ref: '#/components/schemas/InstallCustomerWorkspace'
        cluster_id:
          type: string
          minLength: 1
          maxLength: 54
        product_id:
          type: string
          minLength: 1
          maxLength: 55
          description: >-
            Product ID for product-based installations. Omitted for direct
            installations.
        package_version_id:
          type: string
          minLength: 1
          maxLength: 55
        state:
          type: string
          enum:
            - pending
            - rendering
            - syncing
            - healthy
            - degraded
            - failed
            - deleted
          description: Install lifecycle state from the control plane perspective.
        reconciling:
          type: boolean
        urls:
          type: array
          items:
            $ref: '#/components/schemas/InstallUrl'
        demo_cleanup:
          $ref: '#/components/schemas/InstallDemoCleanup'
        created_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        updated_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        etag:
          type: string
      required:
        - id
        - html_url
        - workspace_id
        - customer_workspace
        - cluster_id
        - package_version_id
        - state
        - reconciling
        - urls
        - created_at
        - updated_at
        - etag
    ApiErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          properties: {}
          description: Always empty for error responses
      required:
        - success
        - errors
        - result
    InstallCustomerWorkspace:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 53
        name:
          type: string
          minLength: 1
          maxLength: 100
      required:
        - id
        - name
    InstallUrl:
      type: object
      properties:
        route_key:
          type: string
        hostname:
          type: string
        url:
          type: string
          format: uri
        protocol:
          type: string
          enum:
            - http
            - websocket
            - grpc
          description: Transport class for route forwarding.
        routing_mode:
          type: string
          enum:
            - through_dispatcher
            - bypass_dispatcher
          description: Whether traffic uses the dispatcher Worker or bypasses it.
        status:
          type: string
          enum:
            - pending
            - provisioning
            - active
            - not_ready
            - failed
          description: Customer-facing install URL routing state.
        error:
          type: string
        last_observed_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
        updated_at:
          type: integer
          minimum: 0
          description: Unix timestamp (seconds)
      required:
        - route_key
        - hostname
        - url
        - protocol
        - routing_mode
        - status
        - updated_at
    InstallDemoCleanup:
      oneOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - scheduled
            cleanup_at:
              type: integer
              minimum: 0
              description: >-
                Unix timestamp when the non-billable demo install is scheduled
                for cleanup.
            removable_by:
              type: string
              enum:
                - platform_policy
                - platform_admin
              description: Authority that may remove the scheduled cleanup policy.
            conversion_required:
              type: string
              enum:
                - paid_order
                - platform_approval
              description: >-
                Required approval path before the demo install can continue
                without cleanup.
            delivery_status:
              type: string
              enum:
                - pending
                - running
                - succeeded
                - failed
              description: >-
                Order delivery status for the install that owns this cleanup
                policy.
          required:
            - kind
            - cleanup_at
            - removable_by
            - conversion_required
            - delivery_status
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - removed
            delivery_status:
              type: string
              enum:
                - pending
                - running
                - succeeded
                - failed
              description: >-
                Order delivery status for the demo install whose cleanup was
                removed.
          required:
            - kind
            - delivery_status
          additionalProperties: false
      description: >-
        Visible cleanup state for non-billable demo installs. Temporal workflow
        IDs and internal cleanup evidence are intentionally omitted.
    ApiErrorEntry:
      type: object
      properties:
        code:
          type: integer
          example: 7002
          description: Machine-readable error code
        message:
          type: string
          example: Resource not found
          description: Human-readable error message
        path:
          type: array
          items:
            type: string
          example:
            - body
            - name
          description: Field path that caused the error, when applicable
        metadata:
          type: object
          additionalProperties:
            type: string
      required:
        - code
        - message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at
        https://akua.dev/developers/api-tokens

````