Environment Restore - Restore Environment

Service:: Power Platform API

API Version:: 2024-10-01

Restores the specified environment to a previous backup.

POST https://api.powerplatform.com/environmentmanagement/environments/{targetEnvironmentId}/restore?api-version=2024-10-01

With optional parameters:

POST https://api.powerplatform.com/environmentmanagement/environments/{targetEnvironmentId}/restore?ValidateOnly={ValidateOnly}&ValidateProperties={ValidateProperties}&api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
targetEnvironmentId	path	True	string	The ID of the target environment that will be overwritten.
api-version	query	True	string	The API version.
ValidateOnly	query		boolean	When true, validates the request without executing it. Use with validateProperties to validate only specific fields. If validateProperties is empty, the entire request is validated. Defaults to false (validate and execute).
ValidateProperties	query		string	A comma-separated list of property names to validate (for example, "property1,property2"). Applies only when validateOnly is true.

Request Body

Media Types: "application/json", "text/json", "application/*+json"

Name	Required	Type	Description
restorePointDateTime	True	string (date-time)	The point in time to restore the environment to. Must include a timezone offset per RFC 3339 (for example, 2025-04-30T12:34:56+02:00).
sourceEnvironmentId	True	string	The ID of the source environment from which the backup will be restored.
restoreOptions		RestoreRequestOptions	Optional inputs for restore request.

Responses

Name	Type	Description
202 Accepted		Accepted
400 Bad Request	ValidationResponse	Bad Request
401 Unauthorized		Unauthorized
403 Forbidden		Forbidden
429 Too Many Requests		Too Many Requests
Other Status Codes	ValidationResponse	Conflict

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name	Description
.default	.default

Definitions

Name	Description
FieldError	The error detail for a single field.
OperationErrorDetail	Structured error detail for a failed request.
RestoreRequest	Request model for restoring an environment to a previous backup.
RestoreRequestOptions	Optional inputs for restore request.
ValidationResponse	Represents the response for validation of an operation.

FieldError

Object

The error detail for a single field.

Name	Type	Description
errorMessages	string[]	The error messages describing what is wrong with the field.
suggestedValue	string	A suggested or accepted value that would resolve the error.

OperationErrorDetail

Object

Structured error detail for a failed request.

Name	Type	Description
code	string	The error code.
fieldErrors	<string, FieldError>	Per-field error detail, keyed by field name.

RestoreRequest

Object

Request model for restoring an environment to a previous backup.

Name	Type	Description
restoreOptions	RestoreRequestOptions	Optional inputs for restore request.
restorePointDateTime	string (date-time)	The point in time to restore the environment to. Must include a timezone offset per RFC 3339 (for example, 2025-04-30T12:34:56+02:00).
sourceEnvironmentId	string	The ID of the source environment from which the backup will be restored.

RestoreRequestOptions

Object

Optional inputs for restore request.

Name	Type	Description
environmentNameToOverride	string	Environment name to override on target environment.
securityGroupIdToOverride	string	Security group ID to override on target environment.
skipAuditData	boolean	Boolean flag to skip audit data during restore.

ValidationResponse

Object

Represents the response for validation of an operation.

Name	Type	Description
errorDetail	OperationErrorDetail	Structured error detail for a failed request.