Azure Blob Storage Azure Blob Storage REST API API

openapi: 3.1.0
info:
  title: Azure Blob Storage REST Append Blobs Azure Blob Storage REST API API
  description: The Azure Blob Storage REST API provides programmatic access to unstructured data storage in Azure. It supports operations on the Blob service, containers, and blobs, including block blobs, append blobs, and page blobs. Blobs can store any type of text or binary data such as documents, media files, and application installers. Blob Storage is optimized for storing massive amounts of unstructured data accessible via HTTP or HTTPS from anywhere in the world.
  version: '2024-11-04'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  termsOfService: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://{accountName}.blob.core.windows.net
  description: Azure Blob Storage endpoint
  variables:
    accountName:
      description: The name of the Azure Storage account
      default: mystorageaccount
security:
- sharedKey: []
- bearerAuth: []
- sharedAccessSignature: []
tags:
- name: Azure Blob Storage REST API
paths:
  /:
    get:
      operationId: listContainers
      summary: Azure Blob Storage List containers
      description: Returns a list of containers under the specified storage account. Results can be filtered by prefix and paginated using marker and maxresults parameters.
      tags:
      - Azure Blob Storage REST API
      parameters:
      - $ref: '#/components/parameters/ApiVersion'
      - name: comp
        in: query
        required: true
        schema:
          type: string
          enum:
          - list
      - name: prefix
        in: query
        description: Filters results to return only containers whose names begin with the specified prefix.
        schema:
          type: string
      - name: marker
        in: query
        description: Continuation token for retrieving the next page of results. Returned in the NextMarker element of a previous response.
        schema:
          type: string
      - name: maxresults
        in: query
        description: Maximum number of containers to return in a single response. Defaults to 5000 if not specified.
        schema:
          type: integer
          minimum: 1
          maximum: 5000
      - name: include
        in: query
        description: Specifies additional datasets to include in the response such as metadata, deleted containers, or system containers.
        schema:
          type: string
          enum:
          - metadata
          - deleted
          - system
      responses:
        '200':
          description: Successfully listed containers
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/ContainerList'
        '403':
          description: Forbidden - authentication or authorization failure
components:
  schemas:
    Container:
      type: object
      description: A blob container in Azure Storage.
      properties:
        Name:
          type: string
          description: The container name
        Properties:
          type: object
          description: System properties of the container
          properties:
            Last-Modified:
              type: string
              format: date-time
              description: Last modification timestamp
            Etag:
              type: string
              description: The ETag value for conditional operations
            LeaseStatus:
              type: string
              enum:
              - locked
              - unlocked
              description: The lease status of the container
            LeaseState:
              type: string
              enum:
              - available
              - leased
              - expired
              - breaking
              - broken
              description: The lease state of the container
            LeaseDuration:
              type: string
              enum:
              - infinite
              - fixed
              description: The duration type of the lease
            PublicAccess:
              type: string
              enum:
              - container
              - blob
              description: The public access level
            HasImmutabilityPolicy:
              type: boolean
              description: Whether an immutability policy exists on the container
            HasLegalHold:
              type: boolean
              description: Whether a legal hold is in effect
            DefaultEncryptionScope:
              type: string
              description: The default encryption scope for the container
            DenyEncryptionScopeOverride:
              type: boolean
              description: Whether blob-level encryption scope override is denied
            ImmutableStorageWithVersioningEnabled:
              type: boolean
              description: Whether version-level immutability is enabled
        Metadata:
          type: object
          description: User-defined key-value metadata pairs
          additionalProperties:
            type: string
    ContainerList:
      type: object
      description: The list of containers returned by the List Containers operation.
      properties:
        ServiceEndpoint:
          type: string
          description: The service endpoint URL
        MaxResults:
          type: integer
          description: Maximum number of results requested
        Prefix:
          type: string
          description: The prefix filter applied
        Containers:
          type: array
          description: The list of containers
          items:
            $ref: '#/components/schemas/Container'
        NextMarker:
          type: string
          description: Continuation token for the next page of results
  parameters:
    ApiVersion:
      name: x-ms-version
      in: header
      required: true
      description: Specifies the version of the Azure Storage REST API to use for the request.
      schema:
        type: string
        default: '2024-11-04'
  securitySchemes:
    sharedKey:
      type: apiKey
      in: header
      name: Authorization
      description: Azure Storage shared key authorization using the storage account access key.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Microsoft Entra ID OAuth 2.0 bearer token for accessing blob resources.
    sharedAccessSignature:
      type: apiKey
      in: query
      name: sig
      description: Shared access signature (SAS) token granting delegated access to blob resources.
externalDocs:
  description: Azure Blob Storage REST API Documentation
  url: https://learn.microsoft.com/en-us/rest/api/storageservices/blob-service-rest-api