API reference
Every HTTP endpoint of the staticwebapps module: authentication, IAM action, parameters, bodies and status codes.
Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.
Docs
GET /docs/staticwebapps/manifest.json
- Authentication: required
- Operation name:
DocsManifest_staticwebapps
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /docs/staticwebapps/{path}
- Authentication: required
- Operation name:
DocsFile_staticwebapps
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
Static Web Apps
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deploy
Rebuild the site from the current branch head
- Authentication: required
- IAM action:
staticwebapp/deploy— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/deploy at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments
Deployment history for a static web app
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments
- Authentication: required
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Request body: DeploymentLogEntryDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/config
Filter and sort options for the deployment history list
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/{deploymentId}
- Authentication: required
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
deploymentId |
path | uuid |
Yes |
Request body: DeploymentLogEntryDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/{deploymentId}/build-logs
Packaging output for one deployment — persisted if it finished, live if it has not
- Authentication: required
- IAM action:
staticwebapp/readLogs— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
deploymentId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/readLogs at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/deployments/{deploymentId}/logs
- Authentication: required
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
deploymentId |
path | uuid |
Yes |
Request body: UploadBuildLogsRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/logs
Stream the site's nginx logs
- Authentication: required
- IAM action:
staticwebapp/readLogs— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/readLogs at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/pods
List the site's serving pods, for the log tab's pod picker
- Authentication: required
- IAM action:
staticwebapp/readLogs— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/readLogs at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/staticwebapps/{name}/rollback
Serve a previously-built image without rebuilding
- Authentication: required
- IAM action:
staticwebapp/deploy— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Request body: StaticWebAppRollbackRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/deploy at the evaluated scope |
POST /boundaries/{boundaryId}/resources/staticwebapps/url
Preview the default public URL for a static web app
- Authentication: required
- IAM action:
staticwebapp/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Request body: StaticWebAppUrlRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/write at the evaluated scope |
StaticWebApp
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps
List all staticwebapps in a resource group
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path - Operation name:
ListStaticWebApps
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/config
Get list configuration for staticwebapps
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path - Operation name:
GetStaticWebAppsConfig
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
resourceGroupName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}
Delete a staticwebapp
- Authentication: required
- IAM action:
staticwebapp/delete— evaluated at the resource in the path - Operation name:
DeleteStaticWebApp
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/delete at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}
Get a specific staticwebapp
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path - Operation name:
GetStaticWebApp
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}
Partially update an existing staticwebapp using JSON Merge Patch
- Authentication: required
- IAM action:
staticwebapp/write— evaluated at the resource in the path - Operation name:
PatchStaticWebApp
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: any
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/write at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}
Create a new staticwebapp
- Authentication: required
- IAM action:
staticwebapp/write— evaluated at the resource in the path - Operation name:
CreateStaticWebApp
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: StaticWebAppDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/write at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}
Update an existing staticwebapp
- Authentication: required
- IAM action:
staticwebapp/write— evaluated at the resource in the path - Operation name:
UpdateStaticWebApp
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: StaticWebAppDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/write at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}/actions/{action}
Execute a lifecycle action (start, stop, restart) on a staticwebapp
- Authentication: required
- IAM action:
staticwebapp/write— evaluated at the resource in the path - Operation name:
ExecuteStaticWebAppAction
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
action |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/write at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}/scale
Get current scale of a staticwebapp
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path - Operation name:
GetStaticWebAppScale
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/staticwebapps/{resourceName}/scale
Scale a staticwebapp
- Authentication: required
- IAM action:
staticwebapp/scale— evaluated at the resource in the path - Operation name:
ScaleStaticWebApp
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: ScaleRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/scale at the evaluated scope |
GET /boundaries/{boundaryId}/resources/staticwebapps
List all staticwebapps across all resource groups
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path - Operation name:
ListAllStaticWebApps
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/staticwebapps/config
Get list configuration for all staticwebapps
- Authentication: required
- IAM action:
staticwebapp/read— evaluated at the resource in the path - Operation name:
GetAllStaticWebAppsConfig
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold staticwebapp/read at the evaluated scope |
Schemas
DeploymentLogEntryDto
| Property | Type | Nullable |
|---|---|---|
boundaryId |
uuid |
No |
branch |
string |
Yes |
canServe |
boolean |
No |
commitSha |
string |
Yes |
containerImage |
string |
Yes |
deploymentId |
uuid |
No |
id |
uuid |
No |
isServing |
boolean |
No |
lastMessage |
string |
No |
phase |
string |
No |
provider |
string |
Yes |
repositoryName |
string |
Yes |
resourceGroupName |
string |
No |
siteName |
string |
No |
source |
string |
Yes |
timestamp |
date-time |
No |
ScaleRequest
| Property | Type | Nullable |
|---|---|---|
targetScale |
integer |
No |
StaticWebAppDeploymentDto
| Property | Type | Nullable |
|---|---|---|
finishedAt |
date-time |
Yes |
image |
string |
Yes |
message |
string |
Yes |
number |
integer |
No |
result |
string |
Yes |
revision |
string |
Yes |
startedAt |
date-time |
Yes |
StaticWebAppDto
| Property | Type | Nullable |
|---|---|---|
boundary |
string |
No |
boundaryId |
uuid |
No |
branch |
string |
No |
cacheControl |
string |
No |
certificateStatus |
string |
Yes |
clusterId |
uuid |
No |
clusterName |
string |
No |
collection |
string |
No |
commit |
string |
Yes |
createdAt |
date-time |
No |
currentDeployment |
StaticWebAppDeploymentDto |
Yes |
headers |
StaticWebAppHeaderDto [] |
Yes |
hostname |
string |
Yes |
httpOnly |
boolean |
No |
id |
uuid |
No |
lastDeployment |
StaticWebAppDeploymentDto |
Yes |
name |
string |
No |
navigationFallback |
string |
Yes |
navigationFallbackExclude |
string [] |
Yes |
notFoundPage |
string |
Yes |
phase |
string |
Yes |
pinnedImage |
string |
Yes |
redirects |
StaticWebAppRedirectDto [] |
Yes |
region |
string |
No |
replicas |
integer |
No |
repositoryId |
string |
No |
repositoryUrl |
string |
No |
resourceGroup |
string |
No |
rolloutError |
string |
Yes |
serveDirectory |
string |
No |
sourceId |
string |
No |
sourceProvider |
string |
No |
specObserved |
boolean |
No |
status |
string |
No |
tags |
map (string) |
No |
url |
string |
Yes |
StaticWebAppHeaderDto
| Property | Type | Nullable |
|---|---|---|
name |
string |
No |
path |
string |
No |
value |
string |
No |
StaticWebAppRedirectDto
| Property | Type | Nullable |
|---|---|---|
from |
string |
No |
statusCode |
integer |
No |
to |
string |
No |
UploadBuildLogsRequest
| Property | Type | Nullable |
|---|---|---|
logs |
string |
No |
timestamp |
date-time |
No |