Share via


Environment State - Enable Environment

Enables the specified environment (Preview).

POST https://api.powerplatform.com/environmentmanagement/environments/{environmentId}/Enable?api-version=2022-03-01-preview
POST https://api.powerplatform.com/environmentmanagement/environments/{environmentId}/Enable?ValidateOnly={ValidateOnly}&ValidateProperties={ValidateProperties}&api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
environmentId
path True

string

The ID of Environment.

api-version
query True

string

The API version.

ValidateOnly
query

boolean

If true, validates the request without executing it.

ValidateProperties
query

string

Comma-separated property names to validate with ValidateOnly.

Request Body

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

Name Type Description
reason

string

The reason of this state change.

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
ErrorInfo

Represents error information for an operation.

StateChangeRequest

Represents a request to change the state of an environment.

ValidationResponse

Represents the response for validation of an operation.

ErrorInfo

Represents error information for an operation.

Name Type Description
code

string

The error Code.

fieldErrors

object

The detailed error.

StateChangeRequest

Represents a request to change the state of an environment.

Name Type Description
reason

string

The reason of this state change.

ValidationResponse

Represents the response for validation of an operation.

Name Type Description
errorDetail

ErrorInfo

Represents error information for an operation.