Microsoft Azure Blobs API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Blob Storage Blobs API
  description: Azure Blob Storage is Microsoft's object storage solution for the cloud. Blob Storage is optimized for storing massive amounts of unstructured data such as text or binary data. The REST API provides operations for working with containers and blobs in storage accounts, including creating, reading, updating, and deleting blobs and containers, managing metadata and properties, and performing lease and snapshot operations.
  version: '2024-05-04'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
    email: azuresupport@microsoft.com
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/
  x-logo:
    url: https://azure.microsoft.com/svghandler/azure-logo.png
servers:
- url: https://{accountName}.blob.core.windows.net
  description: Azure Blob Storage account endpoint
  variables:
    accountName:
      default: mystorageaccount
      description: The name of the Azure storage account.
security:
- sharedKey: []
- oauth2:
  - https://storage.azure.com/.default
- sasToken: []
tags:
- name: Blobs
  description: Operations on blobs
paths:
  /{containerName}/{blob}:
    get:
      operationId: Blob_Download
      summary: Microsoft Azure Download a Blob
      description: Reads or downloads a blob from the system, including its metadata and properties. You can also read a snapshot.
      tags:
      - Blobs
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - $ref: '#/components/parameters/BlobNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: Range
        in: header
        description: Return only the bytes of the blob in the specified range.
        schema:
          type: string
        example: example_value
      - name: x-ms-range-get-content-md5
        in: header
        description: When set to true and the Range header is specified, returns the MD5 hash for the range.
        schema:
          type: boolean
        example: true
      - name: snapshot
        in: query
        description: The snapshot parameter is an opaque DateTime value that specifies the blob snapshot.
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successfully downloaded the blob.
          headers:
            Content-Type:
              schema:
                type: string
            ETag:
              schema:
                type: string
            Last-Modified:
              schema:
                type: string
            x-ms-blob-type:
              schema:
                type: string
                enum:
                - BlockBlob
                - PageBlob
                - AppendBlob
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
              examples:
                BlobDownload200Example:
                  summary: Default Blob_Download 200 response
                  x-microcks-default: true
                  value: example_value
        '206':
          description: Successfully downloaded the requested range of the blob.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
              examples:
                BlobDownload206Example:
                  summary: Default Blob_Download 206 response
                  x-microcks-default: true
                  value: example_value
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                BlobDownloaddefaultExample:
                  summary: Default Blob_Download default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: Blob_Upload
      summary: Microsoft Azure Upload a Blob
      description: Creates a new blob or replaces an existing blob within a container.
      tags:
      - Blobs
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - $ref: '#/components/parameters/BlobNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: x-ms-blob-type
        in: header
        required: true
        description: The type of the blob.
        schema:
          type: string
          enum:
          - BlockBlob
          - PageBlob
          - AppendBlob
        example: BlockBlob
      - name: Content-Type
        in: header
        description: The MIME content type of the blob.
        schema:
          type: string
          default: application/octet-stream
        example: example_value
      - name: Content-Length
        in: header
        required: true
        description: The length of the request body in bytes.
        schema:
          type: integer
          format: int64
        example: 10
      - name: x-ms-blob-content-type
        in: header
        description: The content type to set for the blob.
        schema:
          type: string
        example: example_value
      - name: x-ms-blob-content-encoding
        in: header
        description: The content encoding to set for the blob.
        schema:
          type: string
        example: example_value
      - name: x-ms-access-tier
        in: header
        description: The tier to be set on the blob.
        schema:
          type: string
          enum:
          - Hot
          - Cool
          - Cold
          - Archive
        example: Hot
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
            examples:
              BlobUploadRequestExample:
                summary: Default Blob_Upload request
                x-microcks-default: true
                value: example_value
      responses:
        '201':
          description: Successfully uploaded the blob.
          headers:
            ETag:
              schema:
                type: string
            Last-Modified:
              schema:
                type: string
            Content-MD5:
              schema:
                type: string
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                BlobUploaddefaultExample:
                  summary: Default Blob_Upload default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: Blob_Delete
      summary: Microsoft Azure Delete a Blob
      description: Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection.
      tags:
      - Blobs
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - $ref: '#/components/parameters/BlobNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: snapshot
        in: query
        description: The snapshot to delete.
        schema:
          type: string
        example: example_value
      - name: x-ms-delete-snapshots
        in: header
        description: Required if the blob has associated snapshots.
        schema:
          type: string
          enum:
          - include
          - only
        example: include
      - name: x-ms-lease-id
        in: header
        description: Required if the blob has an active lease.
        schema:
          type: string
        example: '500123'
      responses:
        '202':
          description: The blob has been marked for deletion.
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
              examples:
                BlobDeletedefaultExample:
                  summary: Default Blob_Delete default response
                  x-microcks-default: true
                  value:
                    Code: example_value
                    Message: example_value
                    AuthenticationErrorDetail: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    head:
      operationId: Blob_GetProperties
      summary: Microsoft Azure Get blob properties
      description: Returns all user-defined metadata, standard HTTP properties, and system properties for the blob.
      tags:
      - Blobs
      parameters:
      - $ref: '#/components/parameters/ContainerNameParameter'
      - $ref: '#/components/parameters/BlobNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the blob properties.
          headers:
            Content-Length:
              schema:
                type: integer
                format: int64
            Content-Type:
              schema:
                type: string
            ETag:
              schema:
                type: string
            Last-Modified:
              schema:
                type: string
            x-ms-blob-type:
              schema:
                type: string
                enum:
                - BlockBlob
                - PageBlob
                - AppendBlob
            x-ms-access-tier:
              schema:
                type: string
            x-ms-creation-time:
              schema:
                type: string
        default:
          description: An error occurred.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/StorageError'
components:
  schemas:
    StorageError:
      type: object
      description: Storage service error response.
      properties:
        Code:
          type: string
          description: The error code.
          example: example_value
        Message:
          type: string
          description: The error message.
          example: example_value
        AuthenticationErrorDetail:
          type: string
          description: Additional details for authentication errors.
          example: example_value
  parameters:
    BlobNameParameter:
      name: blob
      in: path
      required: true
      description: The name of the blob.
      schema:
        type: string
        maxLength: 1024
    ContainerNameParameter:
      name: containerName
      in: path
      required: true
      description: The name of the container.
      schema:
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){1,61}[a-z0-9]$
    ApiVersionParameter:
      name: x-ms-version
      in: header
      required: true
      description: Specifies the version of the operation to use for this request.
      schema:
        type: string
        default: '2024-05-04'
  securitySchemes:
    sharedKey:
      type: apiKey
      name: Authorization
      in: header
      description: Azure Storage shared key authorization.
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            https://storage.azure.com/.default: Access Azure Storage
    sasToken:
      type: apiKey
      name: sig
      in: query
      description: Shared Access Signature token.