Microsoft Azure App Service

Azure App Service API

The Azure App Service REST API enables programmatic management of web apps, app service plans, deployment slots, custom domains, SSL certificates, and application settings. It supports continuous deployment, auto-scaling, authentication configuration, and hybrid connections through Azure Resource Manager endpoints.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/appservice/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/appservice/operation-groups
📖
Authentication
https://learn.microsoft.com/en-us/azure/app-service/overview-authentication-authorization

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-app-service/refs/heads/main/openapi/microsoft-azure-app-service-openapi.yml

SDKs

📦
SDK
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/appservice

OpenAPI Specification

microsoft-azure-app-service-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Azure App Service REST API
  description: Azure App Service lets you run web apps, mobile app back ends, and API apps in the cloud.
    The REST API manages App Service plans, web apps, slots, configurations, deployments, and certificates.
  version: '2024-01-01'
externalDocs:
  description: Azure App Service REST API Documentation
  url: https://learn.microsoft.com/en-us/rest/api/appservice/
servers:
- url: https://management.azure.com
  description: Azure Resource Manager
tags:
- name: Web Apps
  description: Web Apps operations
- name: App Service Plans
  description: App Service Plans operations
- name: Slots
  description: Slots operations
- name: Certificates
  description: Certificates operations
- name: Operations
  description: Operations operations
security:
- azure_auth:
  - user_impersonation
paths:
  /providers/Microsoft.Web/operations:
    get:
      operationId: listOperations
      summary: Azure App Service REST API List operations
      description: Lists all available REST API operations for Microsoft.Web.
      tags:
      - Operations
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Operations list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites:
    get:
      operationId: listSitesBySubscription
      summary: Azure App Service REST API List by subscription
      description: Lists all sites resources within the specified subscription.
      tags:
      - Web Apps
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Resource list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites:
    get:
      operationId: listSitesByResourceGroup
      summary: Azure App Service REST API List by resource group
      description: Lists all sites resources within the specified resource group.
      tags:
      - Web Apps
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Resource list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}:
    parameters:
    - $ref: '#/components/parameters/subscriptionId'
    - $ref: '#/components/parameters/resourceGroupName'
    - name: name
      in: path
      required: true
      description: Name of the resource.
      schema:
        type: string
    - $ref: '#/components/parameters/apiVersion'
    get:
      operationId: getSites
      summary: Azure App Service REST API Get resource
      description: Gets a specific sites resource.
      tags:
      - Web Apps
      responses:
        '200':
          description: Resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '404':
          description: Not found
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: createOrUpdateSites
      summary: Azure App Service REST API Create or update resource
      description: Creates or updates a sites resource.
      tags:
      - Web Apps
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resource'
      responses:
        '200':
          description: Resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '201':
          description: Resource created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: updateSites
      summary: Azure App Service REST API Update resource
      description: Updates a sites resource.
      tags:
      - Web Apps
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteSites
      summary: Azure App Service REST API Delete resource
      description: Deletes a sites resource.
      tags:
      - Web Apps
      responses:
        '200':
          description: Resource deleted
        '202':
          description: Deletion accepted
        '204':
          description: Resource not found or already deleted
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    subscriptionId:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
    resourceGroupName:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group.
      schema:
        type: string
    apiVersion:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
  schemas:
    Resource:
      type: object
      properties:
        id:
          type: string
          description: Resource ID.
        name:
          type: string
          description: Resource name.
        type:
          type: string
          description: Resource type.
        location:
          type: string
          description: Resource location.
        tags:
          type: object
          additionalProperties:
            type: string
        properties:
          type: object
          description: Resource-specific properties.
    ResourceList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        nextLink:
          type: string
          description: URL to the next page of results.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            target:
              type: string
    Operation:
      type: object
      properties:
        name:
          type: string
        display:
          type: object
          properties:
            provider:
              type: string
            resource:
              type: string
            operation:
              type: string
            description:
              type: string
        isDataAction:
          type: boolean
    OperationList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
        nextLink:
          type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      description: Azure Active Directory OAuth2 Flow.
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: Impersonate your user account
x-generated-from: https://learn.microsoft.com/en-us/rest/api/appservice/
x-generated-by: claude-crawl-2026-05-08