openapi: 3.1.0
info:
  title: Microsoft SQL Server - Azure SQL & Data API Builder HTTP APIs Azure SQL Databases API
  description: A consolidated view of the HTTP-accessible APIs in the Microsoft SQL Server ecosystem. This document covers (1) the Azure Resource Manager REST API for managing Azure SQL Database resources and (2) the Data API Builder (DAB) runtime that exposes REST endpoints over SQL Server, Azure SQL, PostgreSQL, MySQL, and Azure Cosmos DB. Native SQL Server drivers (ODBC, JDBC, SqlClient, OLE DB, tedious, mssql-python) are not HTTP APIs and are not represented here.
  version: '2025-01-01'
servers:
- url: https://management.azure.com
  description: Azure Resource Manager - Azure SQL Database management
- url: https://{host}
  description: Data API Builder runtime
  variables:
    host:
      default: localhost:5001
security:
- oauth2: []
tags:
- name: Azure SQL Databases
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases:
    get:
      tags:
      - Azure SQL Databases
      summary: List databases on an Azure SQL Server
      operationId: listDatabasesByServer
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: List of databases
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseListResult'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}
  : get:
      tags:
      - Azure SQL Databases
      summary: Get a database
      operationId: getDatabase
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/ServerName'
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: Database
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Database'
        '404':
          description: Not found
    put:
      tags:
      - Azure SQL Databases
      summary: Create or update a database
      operationId: createOrUpdateDatabase
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/ServerName'
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Database'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Database'
        '201':
          description: Created
        '202':
          description: Accepted (long-running operation)
    delete:
      tags:
      - Azure SQL Databases
      summary: Delete a database
      operationId: deleteDatabase
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/ServerName'
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: Deleted
        '202':
          description: Accepted
        '204':
          description: No content
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover
  : post:
      tags:
      - Azure SQL Databases
      summary: Failover a database
      operationId: failoverDatabase
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/ResourceGroupName'
      - $ref: '#/components/parameters/ServerName'
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersion'
      responses:
        '202':
          description: Accepted
components:
  parameters:
    ServerName:
      name: serverName
      in: path
      required: true
      schema:
        type: string
    ResourceGroupName:
      name: resourceGroupName
      in: path
      required: true
      schema:
        type: string
    ApiVersion:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        example: '2025-01-01'
    SubscriptionId:
      name: subscriptionId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    DatabaseListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Database'
        nextLink:
          type: string
          format: uri
    Database:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        location:
          type: string
        sku:
          type: object
          properties:
            name:
              type: string
            tier:
              type: string
            capacity:
              type: integer
        properties:
          type: object
          properties:
            collation:
              type: string
            maxSizeBytes:
              type: integer
            status:
              type: string
            creationDate:
              type: string
              format: date-time
  securitySchemes:
    oauth2:
      type: oauth2
      description: For Azure SQL management endpoints, authenticate via Microsoft Entra ID against https://management.azure.com/.default. Data API Builder endpoints can be configured to use anonymous, EasyAuth, JWT, or Microsoft Entra ID authentication depending on deployment.
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://management.azure.com/.default: Manage Azure resources
x-generated-from: https://learn.microsoft.com/en-us/rest/api/sql/databases
x-generated-by: claude-genwave10-08-2026-05-23