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

# Create an object storage bucket

> Bearer PAT authentication; RBAC permission `credentials.write`. Creates a bucket on one of the organisation's provider credentials (Hetzner, Scaleway, DigitalOcean or UpCloud). Answers 202 with the bucket in `provisioning`; the platform creates it and the bucket moves to `ready` or `error`. Hetzner needs an Object Storage key pair, passed here or already stored on the Hetzner credential; every other provider mints its keys from the credential and refuses a supplied pair.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/object-storage-buckets
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - 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: 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: 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/object-storage-buckets:
    post:
      tags:
        - Object Storage Buckets
      summary: Create an object storage bucket
      description: >-
        Bearer PAT authentication; RBAC permission `credentials.write`. Creates
        a bucket on one of the organisation's provider credentials (Hetzner,
        Scaleway, DigitalOcean or UpCloud). Answers 202 with the bucket in
        `provisioning`; the platform creates it and the bucket moves to `ready`
        or `error`. Hetzner needs an Object Storage key pair, passed here or
        already stored on the Hetzner credential; every other provider mints its
        keys from the credential and refuses a supplied pair.
      operationId: create_object_storage_bucket_pat
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectStorageBucketCreateRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageBucket'
          description: 'Accepted: the bucket is being provisioned'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Invalid request: an unknown credential, an unsupported provider, a
            region of the wrong shape, missing or refused keys, or a name
            already in use
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Permission check failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Internal failure
      security:
        - BearerAuth: []
components:
  schemas:
    ObjectStorageBucketCreateRequest:
      properties:
        access_key_id:
          description: >-
            Hetzner only: the Object Storage access key, issued in the Hetzner
            Cloud Console. Omit it when the pair is stored on the Hetzner
            credential.
          type: string
        bucket:
          description: The provider-side bucket name. Derived from `name` when omitted.
          type: string
        credential_id:
          description: >-
            One of the organisation's provider credentials; its provider decides
            where the bucket is created.
          format: uuid
          type: string
        name:
          description: >-
            A lowercase label such as `registry-storage`, unique in the
            organisation.
          type: string
        region:
          description: >-
            The provider region, such as `fsn1` (Hetzner), `fr-par` (Scaleway),
            `fra1` (DigitalOcean) or `europe-1` (UpCloud).
          type: string
        secret_access_key:
          description: 'Hetzner only: the secret half of the Object Storage key pair.'
          type: string
      required:
        - name
        - credential_id
        - region
      title: ObjectStorageBucketCreateRequest
      type: object
    ObjectStorageBucket:
      description: >-
        An object storage bucket Ankra created on one of the organisation's
        provider credentials. Key material is never part of it.
      properties:
        bucket:
          description: The provider-side bucket name.
          type: string
        created_at:
          format: date-time
          type: string
        credential_id:
          description: The provider credential the bucket was created with.
          format: uuid
          type: string
        endpoint:
          description: >-
            The S3 endpoint. Empty until provisioning knows it (an UpCloud
            endpoint exists only once its service does).
          type: string
        error_excerpt:
          description: Why provisioning or a teardown failed; present only in `error`.
          type: string
        id:
          format: uuid
          type: string
        name:
          description: The Ankra-side name, unique in the organisation.
          type: string
        path_style:
          type: boolean
        provider:
          enum:
            - hetzner
            - scaleway
            - digitalocean
            - upcloud
          type: string
        region:
          type: string
        status:
          enum:
            - provisioning
            - ready
            - error
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - name
        - provider
        - region
        - bucket
        - endpoint
        - path_style
        - credential_id
        - status
        - created_at
        - updated_at
      title: ObjectStorageBucket
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    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
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````