Azure File Storage REST API

openapi: 3.1.0
info:
  title: Azure File Storage REST API
  description: Azure File Storage REST API enables clients to manage shares, directories, and files within
    a storage account using SMB-like operations over HTTP.
  version: '2024-05-04'
externalDocs:
  description: Azure File Storage REST API Documentation
  url: https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api
servers:
- url: https://{account}.file.core.windows.net
  variables:
    account:
      default: myaccount
      description: Storage account name
tags:
- name: Service
  description: Account-level operations
- name: Shares
  description: Shares operations
security:
- sharedKey: []
- sasToken: []
paths:
  /:
    get:
      operationId: listContainers
      summary: Azure File Storage REST API List
      description: Lists shares in the account.
      tags:
      - Shares
      parameters:
      - name: comp
        in: query
        required: true
        schema:
          type: string
          enum:
          - list
      responses:
        '200':
          description: Shares listing
          content:
            application/xml:
              schema:
                type: object
  /{container}:
    parameters:
    - name: container
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: createContainer
      summary: Azure File Storage REST API Create
      description: Creates a new share.
      tags:
      - Shares
      responses:
        '201':
          description: Created
    get:
      operationId: getContainerProperties
      summary: Azure File Storage REST API Get properties
      description: Returns the properties of the share.
      tags:
      - Shares
      responses:
        '200':
          description: Properties
    delete:
      operationId: deleteContainer
      summary: Azure File Storage REST API Delete
      description: Deletes the share.
      tags:
      - Shares
      responses:
        '202':
          description: Deletion accepted
  /{container}/{path}:
    parameters:
    - name: container
      in: path
      required: true
      schema:
        type: string
    - name: path
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: putItem
      summary: Azure File Storage REST API Put item
      description: Creates or updates a resource at the path.
      tags:
      - Shares
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Created
    get:
      operationId: getItem
      summary: Azure File Storage REST API Get item
      description: Retrieves a resource at the path.
      tags:
      - Shares
      responses:
        '200':
          description: OK
    delete:
      operationId: deleteItem
      summary: Azure File Storage REST API Delete item
      description: Deletes a resource at the path.
      tags:
      - Shares
      responses:
        '202':
          description: Deletion accepted
components:
  securitySchemes:
    sharedKey:
      type: apiKey
      in: header
      name: Authorization
      description: Shared Key authentication
    sasToken:
      type: apiKey
      in: query
      name: sig
      description: Shared Access Signature token
x-generated-from: https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api
x-generated-by: claude-crawl-2026-05-08