# Microsoft Azure Functions Static Sites API

**Canonical:** https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-static-sites-api/  
**Provider:** Microsoft Azure Functions — https://apis.io/providers/microsoft-azure-functions/  
**Base URL:** https://{functionapp}.azurewebsites.net  
**Documentation:** https://learn.microsoft.com/en-us/azure/azure-functions/functions-reference

Microsoft Azure Functions Static Sites API is one of 23 APIs that [Microsoft Azure Functions](https://apis.io/providers/microsoft-azure-functions/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Static Sites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, and authentication docs.

The Static Sites API from Microsoft Azure Functions — 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 |
| 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 |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listConfiguredRoles` | Lists the roles configured for the static site |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings` | Gets the application settings of a static site |
| POST | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listSecrets` | Lists the secrets for an existing static site |

…and 15 more operations. They are listed in full on the page.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/microsoft-azure-functions/refs/heads/main/openapi/microsoft-azure-functions-static-sites-api-openapi.yml
- **Documentation** — https://learn.microsoft.com/en-us/rest/api/appservice/web-apps
- **GettingStarted** — https://learn.microsoft.com/en-us/azure/azure-functions/functions-get-started
- **APIReference** — https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/get
- **Authentication** — https://learn.microsoft.com/en-us/rest/api/azure/#register-your-client-application-with-azure-ad

## Other Microsoft Azure Functions APIs (12)

- [Azure Functions Runtime API](https://apis.io/apis/microsoft-azure-functions/azure-functions-runtime-api/)
- [Microsoft Azure Functions AppServiceEnvironments API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-appserviceenvironments-api/)
- [Microsoft Azure Functions AppServicePlans API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-appserviceplans-api/)
- [Microsoft Azure Functions Certificates API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-certificates-api/)
- [Microsoft Azure Functions DeletedWebApps API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-deletedwebapps-api/)
- [Microsoft Azure Functions Diagnostics API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-diagnostics-api/)
- [Microsoft Azure Functions Global API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-global-api/)
- [Microsoft Azure Functions KubeEnvironments API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-kubeenvironments-api/)
- [Microsoft Azure Functions Operations API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-operations-api/)
- [Microsoft Azure Functions Provider API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-provider-api/)
- [Microsoft Azure Functions Providers API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-providers-api/)
- [Microsoft Azure Functions Recommendations API](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-recommendations-api/)

## Tags

Static Sites

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/microsoft-azure-functions/microsoft-azure-functions-static-sites-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/microsoft-azure-functions/.
