Azure Data Lake Storage REST API

Azure Data Lake Storage Gen2 REST API provides a file system interface for big data analytics workloads on Azure Blob Storage. It supports creating file systems, managing directories and files with hierarchical namespace, setting ACLs, and integrating with analytics engines.

OpenAPI Specification

microsoft-azure-data-lake-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Azure Data Lake Storage Gen2 REST API
  description: Azure Data Lake Storage Gen2 REST API supports filesystem and path operations on hierarchical
    namespace storage accounts. Authentication is via Shared Key, SAS, or Azure AD bearer tokens.
  version: '2024-05-04'
externalDocs:
  description: Azure Data Lake Storage Gen2 REST API Documentation
  url: https://learn.microsoft.com/en-us/rest/api/storageservices/data-lake-storage-gen2
servers:
- url: https://{account}.dfs.core.windows.net
  variables:
    account:
      default: myaccount
      description: Storage account name
tags:
- name: Service
  description: Account-level operations
- name: Filesystems
  description: Filesystems operations
security:
- sharedKey: []
- sasToken: []
paths:
  /:
    get:
      operationId: listContainers
      summary: Azure Data Lake Storage Gen2 REST API List
      description: Lists filesystems in the account.
      tags:
      - Filesystems
      parameters:
      - name: comp
        in: query
        required: true
        schema:
          type: string
          enum:
          - list
      responses:
        '200':
          description: Filesystems listing
          content:
            application/xml:
              schema:
                type: object
  /{container}:
    parameters:
    - name: container
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: createContainer
      summary: Azure Data Lake Storage Gen2 REST API Create
      description: Creates a new filesystem.
      tags:
      - Filesystems
      responses:
        '201':
          description: Created
    get:
      operationId: getContainerProperties
      summary: Azure Data Lake Storage Gen2 REST API Get properties
      description: Returns the properties of the filesystem.
      tags:
      - Filesystems
      responses:
        '200':
          description: Properties
    delete:
      operationId: deleteContainer
      summary: Azure Data Lake Storage Gen2 REST API Delete
      description: Deletes the filesystem.
      tags:
      - Filesystems
      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 Data Lake Storage Gen2 REST API Put item
      description: Creates or updates a resource at the path.
      tags:
      - Filesystems
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '201':
          description: Created
    get:
      operationId: getItem
      summary: Azure Data Lake Storage Gen2 REST API Get item
      description: Retrieves a resource at the path.
      tags:
      - Filesystems
      responses:
        '200':
          description: OK
    delete:
      operationId: deleteItem
      summary: Azure Data Lake Storage Gen2 REST API Delete item
      description: Deletes a resource at the path.
      tags:
      - Filesystems
      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/data-lake-storage-gen2
x-generated-by: claude-crawl-2026-05-08