通过

Environment Restore - Restore Environment

Service:
Power Platform API
API Version:
2022-03-01-preview

Restores the specified environment to a previous backup (Preview).

POST https://api.powerplatform.com/environmentmanagement/environments/{targetEnvironmentId}/Restore?api-version=2022-03-01-preview
With optional parameters: 
POST https://api.powerplatform.com/environmentmanagement/environments/{targetEnvironmentId}/Restore?ValidateOnly={ValidateOnly}&ValidateProperties={ValidateProperties}&api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
targetEnvironmentId
 path True

string

The target environment ID.
api-version
 query True

string

The API version.
ValidateOnly
 query

boolean

The value which indicates whether the operation is a validated only request. Examples:

validateOnly=true with validateProperties non-empty: Validate only the listed properties, ignoring others even if present in the body.

validateOnly=true with empty/absent validateProperties: Validate the entire body (equivalent to full validation).

validateOnly=false or omitted: Process the full request(validate and execute).
ValidateProperties
 query

string

The value which indicates what properties should be validated. Need to work together with ValidateOnly. Properties should be separated by ','. Example: "property1,property2,property3".

Request Body

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

Name Required Type Description
restorePointDateTime True

string (date-time)

Date and time of when the restore point is. Date and time should include with timezone offset per RFC 3339 (e.g., 2025-04-30T12:34:56+02:00).
sourceEnvironmentId True

string

The ID of the source environment from which the backup will be restored from.
skipAuditData

boolean

A value indicating whether to skip audit data during the restore process.

Responses

Name Type Description
202 Accepted

Accepted

Media Types: "text/plain", "application/json", "text/json"
400 Bad Request

ValidationResponse

Bad Request

Media Types: "text/plain", "application/json", "text/json"

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
EnvironmentRestoreRequest

Request model for restoring an environment to a previous backup.
ErrorInfo

Represents error information for an operation.
ValidationResponse

Represents the response for validation of an operation.

EnvironmentRestoreRequest

Object

Request model for restoring an environment to a previous backup.

Name Type Description
restorePointDateTime

string (date-time)

Date and time of when the restore point is. Date and time should include with timezone offset per RFC 3339 (e.g., 2025-04-30T12:34:56+02:00).
skipAuditData

boolean

A value indicating whether to skip audit data during the restore process.
sourceEnvironmentId

string

The ID of the source environment from which the backup will be restored from.

ErrorInfo

Object

Represents error information for an operation.

Name Type Description
code

string

The error Code.
fieldErrors

object

The detailed error.

ValidationResponse

Object

Represents the response for validation of an operation.

Name Type Description
errorDetail

ErrorInfo

Represents error information for an operation.