# Microsoft Azure App Service Static Sites API **Canonical:** https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-static-sites-api/ **Provider:** Microsoft Azure App Service — https://apis.io/providers/microsoft-azure-app-service/ **Base URL:** https://management.azure.com **Documentation:** https://learn.microsoft.com/en-us/rest/api/appservice/ Microsoft Azure App Service Static Sites API is one of 24 APIs that [Microsoft Azure App Service](https://apis.io/providers/microsoft-azure-app-service/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Static Sites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and 2 JSON Schemas. The Static Sites API from Microsoft Azure App Service — 51 operation(s) for static sites. ## Operations (60 of 75) | Method | Path | Summary | |---|---|---| | POST | `/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile` | Generates a preview workflow file for the static site | | GET | `/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites` | Get all Static Sites for a subscription | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites` | Gets all static sites in the specified resource group | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}` | Gets the details of a static site | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}` | Creates a new static site in an existing resource group, or updates an existing… | | PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}` | Creates a new static site in an existing resource group, or updates an existing… | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}` | Deletes a static site | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers` | Gets the list of users of a static site | | PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}` | Updates a user entry with the listed roles | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}` | Deletes the user entry from the static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth` | Gets the basic auth properties for a static site as a collection | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}` | Gets the basic auth properties for a static site | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}` | Adds or updates basic auth for a static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds` | Gets all static site builds for a particular static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}` | Gets the details of a static site build | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}` | Deletes a static site build | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/appsettings` | Creates or updates the app settings of a static site build | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/functionappsettings` | Creates or updates the function app settings of a static site build | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections` | Returns overviews of database connections for a static site build | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}` | Returns overview of a database connection for a static site build by name | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}` | Create or update a database connection for a static site build | | PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}` | Create or update a database connection for a static site build | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}` | Delete a database connection for a static site build | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}/show` | Returns details of a database connection for a static site build by name | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions` | Gets the functions of a particular static site build | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends` | Returns details of all backends linked to a static site build | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}` | Returns the details of a linked backend linked to a static site build by name | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}` | Link backend to a static site build | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}` | Unlink a backend from a static site build | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}/validate` | Validates that a backend can be linked to a static site build | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listAppSettings` | Gets the application settings of a static site build | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listFunctionAppSettings` | Gets the application settings of a static site build | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/showDatabaseConnections` | Returns details of database connections for a static site build | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps` | Gets the details of the user provided function apps registered with a static… | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}` | Gets the details of the user provided function app registered with a static… | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}` | Register a user provided function app with a static site build | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}` | Detach the user provided function app from the static site build | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/zipdeploy` | Deploys zipped content to a specific environment of a static site | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings` | Creates or updates the app settings of a static site | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings` | Creates or updates the function app settings of a static site | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation` | Creates an invitation link for a user with the role | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains` | Gets all static site custom domains for a particular static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}` | Gets an existing custom domain for a particular static site | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}` | Creates a new static site custom domain in an existing resource group and… | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}` | Deletes a custom domain | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}/validate` | Validates a particular custom domain can be added to a static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections` | Returns overviews of database connections for a static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}` | Returns overview of a database connection for a static site by name | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}` | Create or update a database connection for a static site | | PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}` | Create or update a database connection for a static site | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}` | Delete a database connection for a static site | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}/show` | Returns details of a database connection for a static site by name | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/detach` | Detaches a static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions` | Gets the functions of a static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends` | Returns details of all backends linked to a static site | | GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}` | Returns the details of a linked backend linked to a static site by name | | PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}` | Link backend to a static site | | DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}` | Unlink a backend from a static site | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}/validate` | Validates that a backend can be linked to a static site | | POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings` | Gets the application settings of a static site | …and 15 more operations. They are listed in full on the page. ## Machine-readable artifacts (7) - **OpenAPI** — https://artifacts.apis.io/microsoft-azure-app-service/openapi/microsoft-azure-app-service-static-sites-api-openapi.yml - **Documentation** — https://learn.microsoft.com/en-us/rest/api/appservice/ - **SDKs** — https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/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 - **JSONSchema** — https://artifacts.apis.io/microsoft-azure-app-service/json-schema/microsoft-azure-app-service-resource-schema.json - **JSONSchema** — https://artifacts.apis.io/microsoft-azure-app-service/json-schema/microsoft-azure-app-service-resource-list-schema.json ## Other Microsoft Azure App Service APIs (12) - [Microsoft Azure App Service Operations API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-operations-api/) - [Microsoft Azure App Service AI Gateways API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-aigateways-api/) - [Microsoft Azure App Service App Service Environments API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-appserviceenvironments-api/) - [Microsoft Azure App Service App Service Plans API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-appserviceplans-api/) - [Microsoft Azure App Service Certificates API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-certificates-api/) - [Microsoft Azure App Service Deleted Web Apps API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-deletedwebapps-api/) - [Microsoft Azure App Service Diagnostics API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-diagnostics-api/) - [Microsoft Azure App Service Global API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-global-api/) - [Microsoft Azure App Service Kube Environments API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-kubeenvironments-api/) - [Microsoft Azure App Service Provider API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-provider-api/) - [Microsoft Azure App Service Providers API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-providers-api/) - [Microsoft Azure App Service Recommendations API](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-recommendations-api/) ## Tags Static Sites --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/microsoft-azure-app-service/microsoft-azure-app-service-static-sites-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/microsoft-azure-app-service/.