Apache Ozone Buckets API

openapi: 3.0.3
info:
  title: Apache Ozone S3-Compatible Buckets API
  description: Apache Ozone provides an S3-compatible REST API for object storage operations including bucket and key management, multipart uploads, and access control lists.
  version: 1.4.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    url: https://ozone.apache.org/
servers:
- url: https://{host}
  description: Apache Ozone S3 Gateway
  variables:
    host:
      default: localhost:9878
tags:
- name: Buckets
paths:
  /{bucket}:
    put:
      operationId: createBucket
      summary: Apache Ozone Create Bucket
      description: Create a new S3-compatible bucket in Ozone.
      tags:
      - Buckets
      parameters:
      - $ref: '#/components/parameters/bucket'
      responses:
        '200':
          description: Bucket created
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: listObjects
      summary: Apache Ozone List Objects
      description: List objects in a bucket with optional prefix, delimiter, and pagination.
      tags:
      - Buckets
      parameters:
      - $ref: '#/components/parameters/bucket'
      - name: prefix
        in: query
        schema:
          type: string
        description: Object key prefix filter
      - name: delimiter
        in: query
        schema:
          type: string
        description: Delimiter for grouping keys
      - name: max-keys
        in: query
        schema:
          type: integer
          default: 1000
        description: Maximum number of keys to return
      - name: continuation-token
        in: query
        schema:
          type: string
        description: Pagination token
      responses:
        '200':
          description: List of objects
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ListObjectsResult'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteBucket
      summary: Apache Ozone Delete Bucket
      description: Delete an empty bucket.
      tags:
      - Buckets
      parameters:
      - $ref: '#/components/parameters/bucket'
      responses:
        '204':
          description: Bucket deleted
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    head:
      operationId: headBucket
      summary: Apache Ozone Head Bucket
      description: Check if a bucket exists and you have permission to access it.
      tags:
      - Buckets
      parameters:
      - $ref: '#/components/parameters/bucket'
      responses:
        '200':
          description: Bucket exists
        '404':
          description: Bucket not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /:
    get:
      operationId: listBuckets
      summary: Apache Ozone List Buckets
      description: List all buckets owned by the authenticated user.
      tags:
      - Buckets
      responses:
        '200':
          description: List of buckets
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ListAllMyBucketsResult'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    bucket:
      name: bucket
      in: path
      required: true
      schema:
        type: string
      description: Bucket name
      example: my-bucket
  schemas:
    Object:
      type: object
      properties:
        key:
          type: string
          example: data/file.csv
        lastModified:
          type: string
          format: date-time
          example: '2026-04-19T10:00:00Z'
        etag:
          type: string
          example: '"a1b2c3d4e5f6"'
        size:
          type: integer
          example: 1048576
        storageClass:
          type: string
          example: STANDARD
        owner:
          $ref: '#/components/schemas/Owner'
    Bucket:
      type: object
      properties:
        name:
          type: string
          example: my-bucket
        creationDate:
          type: string
          format: date-time
          example: '2026-04-19T10:00:00Z'
        storageClass:
          type: string
          example: STANDARD
    Owner:
      type: object
      properties:
        id:
          type: string
          example: ozone-user-001
        displayName:
          type: string
          example: ozone-admin
    ListAllMyBucketsResult:
      type: object
      properties:
        owner:
          $ref: '#/components/schemas/Owner'
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/Bucket'
    ListObjectsResult:
      type: object
      properties:
        name:
          type: string
          example: my-bucket
        prefix:
          type: string
          example: data/
        maxKeys:
          type: integer
          example: 1000
        isTruncated:
          type: boolean
          example: false
        nextContinuationToken:
          type: string
        contents:
          type: array
          items:
            $ref: '#/components/schemas/Object'
x-generated-from: documentation