> ## 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. # Set automatic install updates > Enables or disables automatic PackageVersion updates for one install. ## OpenAPI ````yaml /openapi-public.json patch /installs/{id}/automatic_updates 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: /installs/{id}/automatic_updates: patch: tags: - Installs summary: Set automatic install updates description: Enables or disables automatic PackageVersion updates for one install. operationId: installs.setAutomaticUpdates parameters: - name: id in: path schema: type: string minLength: 1 maxLength: 55 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: if-match in: header schema: type: string minLength: 1 maxLength: 256 description: >- The `etag` of the resource version the client last read. Required on writes when the resource exposes an `etag` field. Mismatch returns 409 `ABORTED` with the current etag in the error metadata. examples: - '42' required: true - name: idempotency-key in: header schema: type: string minLength: 1 maxLength: 64 description: >- Required 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: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SetInstallAutomaticUpdatesBody' required: true responses: '200': description: Automatic-update policy updated content: application/json: schema: $ref: '#/components/schemas/InstallLifecycleMutation' '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. | The resource changed since the etag the client sent; the current etag is in the metadata. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ApiConflict' - $ref: '#/components/schemas/ApiPreconditionFailed' security: - BearerAuth: [] components: schemas: SetInstallAutomaticUpdatesBody: type: object properties: automatic_updates_enabled: type: boolean required: - automatic_updates_enabled additionalProperties: false InstallLifecycleMutation: type: object properties: install: $ref: '#/components/schemas/InstallLifecycleState' render: anyOf: - $ref: '#/components/schemas/InstallRender' - type: 'null' required: - install - render 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 ApiPreconditionFailed: type: object properties: _tag: type: string enum: - PreconditionFailed success: type: boolean enum: - false errors: type: array prefixItems: - type: object properties: code: type: number enum: - 7006 message: type: string metadata: type: object properties: current_etag: type: string required: - current_etag allOf: - type: object additionalProperties: type: string required: - code - message - metadata additionalProperties: false maxItems: 1 minItems: 1 result: type: object additionalProperties: false required: - _tag - success - errors - result additionalProperties: false InstallLifecycleState: type: object properties: id: type: string minLength: 1 maxLength: 55 current_version: anyOf: - $ref: '#/components/schemas/PackageVersionSummary' - type: 'null' description: Last PackageVersion whose render completed successfully. desired_version: anyOf: - $ref: '#/components/schemas/PackageVersionSummary' - type: 'null' description: >- Requested PackageVersion while an update or restore is pending or has failed. Null when desired and current match. automatic_updates_enabled: type: boolean updated_at: type: integer minimum: 0 description: Unix timestamp (seconds) etag: type: string required: - id - current_version - desired_version - automatic_updates_enabled - updated_at - etag additionalProperties: false InstallRender: type: object properties: id: type: string minLength: 1 maxLength: 54 workspace_id: type: string minLength: 1 maxLength: 53 install_id: type: string minLength: 1 maxLength: 55 operation_id: anyOf: - type: string minLength: 1 maxLength: 53 - type: 'null' repository_change_request_id: anyOf: - type: string minLength: 1 maxLength: 54 - type: 'null' render_hash: anyOf: - type: string - type: 'null' commit_sha: anyOf: - type: string - type: 'null' package_version_id: anyOf: - type: string minLength: 1 maxLength: 55 - type: 'null' restored_from_render_id: anyOf: - type: string minLength: 1 maxLength: 54 - type: 'null' state: type: string enum: - running - deployed - skipped - failed message: anyOf: - type: string - type: 'null' created_at: type: integer minimum: 0 description: Unix timestamp (seconds) updated_at: type: integer minimum: 0 description: Unix timestamp (seconds) required: - id - workspace_id - install_id - render_hash - state - created_at - updated_at 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 PackageVersionSummary: type: object properties: id: type: string minLength: 1 maxLength: 55 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-]+)*))?$ required: - id - semver 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.