POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob/?api-version=2023-01-01

Description for Restores an app from a backup blob in Azure Storage.

Servers

https://management.azure.com/

Path parameters

Name	Type	Required	Description
`name`	String	Yes	Name of the app.
`slot`	String	Yes	Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.
`subscriptionId`	String	Yes	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
`resourceGroupName`	String	Yes	Name of the resource group to which the resource belongs.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	Resource Id.
`name`	String	No	Resource Name.
`properties`	Object	No	RestoreRequest resource specific properties
`properties.ignoreDatabases`	Boolean	No	Ignore the databases and only restore the site content Default value: false
`properties.databases[]`	Array	No	Collection of databases which should be restored. This list has to match the list of databases included in the backup.
`properties.databases[].connectionStringName`	String	No	Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
`properties.databases[].name`	String	No
`properties.databases[].connectionString`	String	No	Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
`properties.databases[].databaseType`	String	Yes	Database type (e.g. SqlAzure / MySql). Possible values: `"SqlAzure"` `"PostgreSql"` `"MySql"` `"LocalMySql"`
`properties.storageAccountUrl`	String	Yes	SAS URL to the container.
`properties.blobName`	String	No	Name of a blob which contains the backup.
`properties.ignoreConflictingHostNames`	Boolean	No	Changes a logic when restoring an app with custom domains. `true` to remove custom domains automatically. If `false`, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. Default value: false
`properties.overwrite`	Boolean	Yes	`true` if the restore operation can overwrite target app; otherwise, `false`. `true` is needed if trying to restore over an existing app.
`properties.hostingEnvironment`	String	No	App Service Environment name, if needed (only when restoring an app to an App Service Environment).
`properties.appServicePlan`	String	No	Specify app service plan that will own restored site.
`properties.adjustConnectionStrings`	Boolean	No	`true` if SiteConfig.ConnectionStrings should be set in new app; otherwise, `false`.
`properties.siteName`	String	No	Name of an app.
`properties.operationType`	String	No	Operation type. Possible values: `"Clone"` `"Default"` `"CloudFS"` `"Relocation"` `"Snapshot"` Default value: "Default"
`type`	String	No	Resource type.
`kind`	String	No	Kind of resource.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.