> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Set paid registry storage

> Set how many paid storage blocks the organisation holds and apply the new limit to the registry at once. Each block adds block_gib GiB to every registry project's limit and is billed on the monthly invoice, prorated by the days held. Buying more needs billing that can pay (402 with a sentence saying what to fix on the Billing page; 503 when billing could not be checked). More than max_blocks, a decrease below what the registry holds, or a purchase while sales are paused answer 422 with the figures. A stale expected_version answers 409. Requires billing.manage. A browser session twin is mounted at the same path without the /api/v1 prefix (cookie authentication, CSRF header).



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/registry-storage/addon
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/registry-storage/addon:
    put:
      tags:
        - Credentials
      summary: Set paid registry storage
      description: >-
        Set how many paid storage blocks the organisation holds and apply the
        new limit to the registry at once. Each block adds block_gib GiB to
        every registry project's limit and is billed on the monthly invoice,
        prorated by the days held. Buying more needs billing that can pay (402
        with a sentence saying what to fix on the Billing page; 503 when billing
        could not be checked). More than max_blocks, a decrease below what the
        registry holds, or a purchase while sales are paused answer 422 with the
        figures. A stale expected_version answers 409. Requires billing.manage.
        A browser session twin is mounted at the same path without the /api/v1
        prefix (cookie authentication, CSRF header).
      operationId: update_registry_storage_addon_api_v1_org_registry_storage_addon_put
      parameters:
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistryStorageAddonUpdateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryStorageAddonUpdateResult'
          description: Successful Response
        '401':
          description: Unauthorized
        '402':
          description: >-
            Billing cannot pay for more storage: no paid plan, no payment
            method, or an overdue invoice; nothing was bought
        '403':
          description: Forbidden
        '409':
          description: >-
            The add-on or its price changed since you read it (expected_version
            is stale); nothing was written
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '503':
          description: >-
            Billing or the registry's usage could not be checked, or the Ankra
            registry is not available; nothing was written
components:
  schemas:
    RegistryStorageAddonUpdateRequest:
      type: object
      properties:
        blocks:
          type: integer
          minimum: 0
          description: >-
            The number of blocks the organisation should hold (0 returns them
            all). Required.
        expected_version:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The version read with the add-on. When sent and stale, the change
            answers 409 and nothing is bought or returned.
      required:
        - blocks
      title: RegistryStorageAddonUpdateRequest
    RegistryStorageAddonUpdateResult:
      type: object
      properties:
        addon:
          $ref: '#/components/schemas/RegistryStorageAddon'
        storage:
          $ref: '#/components/schemas/RegistryStorage'
        harbor_applied:
          type: boolean
          description: >-
            false means the change is saved and the registry gets the new limit
            on the next provisioning pass, within about five minutes.
        harbor_apply_error:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - addon
        - storage
        - harbor_applied
        - harbor_apply_error
      title: RegistryStorageAddonUpdateResult
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    RegistryStorageAddon:
      type: object
      description: >-
        The organisation's paid registry storage: blocks it holds on top of its
        base limit, what they cost, and whether more can be bought.
      properties:
        available:
          type: boolean
          description: >-
            false when storage cannot be bought at all: sales are paused, the
            base limit is already no limit, or the organisation is on no paid
            plan. Reducing is always possible.
        unavailable_reason:
          anyOf:
            - type: string
            - type: 'null'
          description: Why available is false, in plain words.
        block_gib:
          type: integer
          description: The size of one block in GiB.
        price_cents_per_block_month:
          type: integer
          description: >-
            What one block costs this organisation per month, in cents of
            currency: the price it holds its blocks at, or the platform price
            when it holds none.
        currency:
          type: string
          description: 'Always eur: every invoice is euro-denominated.'
        max_blocks:
          type: integer
          description: >-
            The most blocks an organisation may buy itself; for more, request
            more storage.
        blocks:
          type: integer
          description: The blocks held now.
        base_limit_bytes:
          type: integer
          description: The limit before blocks; -1 is no limit.
        effective_limit_bytes:
          type: integer
          description: >-
            base_limit_bytes + blocks x block_gib GiB: the limit every registry
            project carries; -1 is no limit.
        monthly_cents:
          type: integer
          description: What the blocks held now cost per month.
        scheduled_price_cents_per_block_month:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            A staff price change that reaches the blocks held at
            scheduled_price_from (the next calendar month); null when none.
        scheduled_price_from:
          anyOf:
            - type: string
            - type: 'null'
          format: date-time
        billing_ready:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            true when billing can pay for more blocks, false when it cannot
            (billing_blocker says why), null when billing could not be checked
            (billing_blocker says so).
        billing_blocker:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            A plain sentence for the Billing page link: no paid plan, no payment
            method, an overdue invoice, or that billing could not be checked.
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          format: date-time
        version:
          type: string
          description: >-
            Opaque version of the stored add-on and its price. Send it back as
            expected_version.
      required:
        - available
        - unavailable_reason
        - block_gib
        - price_cents_per_block_month
        - currency
        - max_blocks
        - blocks
        - base_limit_bytes
        - effective_limit_bytes
        - monthly_cents
        - scheduled_price_cents_per_block_month
        - scheduled_price_from
        - billing_ready
        - billing_blocker
        - updated_by
        - updated_at
        - version
      title: RegistryStorageAddon
    RegistryStorage:
      type: object
      properties:
        organisation_id:
          type: string
        limit_bytes:
          type: integer
          description: >-
            The storage limit in force for each of the organisation's registry
            projects, in bytes: base_limit_bytes plus the paid storage blocks
            the organisation holds; -1 is no limit.
        base_limit_bytes:
          type: integer
          description: >-
            The limit before paid storage blocks: the organisation's own limit
            (source organisation) or the platform default (source default); -1
            is no limit.
        addon_blocks:
          type: integer
          description: >-
            The paid storage blocks the organisation holds (see
            /api/v1/org/registry-storage/addon).
        addon_monthly_cents:
          type: integer
          description: >-
            What those blocks cost per month at the price they are held at now,
            in cents of the add-on currency.
        default_limit_bytes:
          type: integer
          description: >-
            The platform default an organisation with no limit of its own
            carries.
        source:
          type: string
          enum:
            - default
            - organisation
        reason:
          anyOf:
            - type: string
            - type: 'null'
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          format: date-time
        used_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            What the organisation's projects hold; absent when no project could
            be read, a lower bound when usage_status is partial.
        usage_status:
          type: string
          enum:
            - complete
            - partial
            - unknown
            - not_provisioned
        projects:
          type: array
          items:
            $ref: '#/components/schemas/RegistryStorageProject'
      required:
        - organisation_id
        - limit_bytes
        - base_limit_bytes
        - addon_blocks
        - addon_monthly_cents
        - default_limit_bytes
        - source
        - reason
        - updated_by
        - updated_at
        - used_bytes
        - usage_status
        - projects
      title: RegistryStorage
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    RegistryStorageProject:
      type: object
      properties:
        name:
          type: string
          description: >-
            default for the organisation's own project, otherwise the extra
            project's name.
        project:
          type: string
          description: The registry project name.
        limit_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The quota the registry enforces on this project now; -1 is no limit.
            Absent when the project could not be read.
        used_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            What the project holds against its quota. Absent when it could not
            be read.
        status:
          type: string
          enum:
            - ok
            - unknown
      required:
        - name
        - project
        - limit_bytes
        - used_bytes
        - status
      title: RegistryStorageProject

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.