Share via


Environments - List Environments For User

Retrieve a list of environments (preview).
Returns a list of environments available for the authenticated user.

GET https://api.powerplatform.com/environmentmanagement/environments?api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
api-version
query True

string

The API version.

Responses

Name Type Description
200 OK

EnvironmentList

A list of environments.

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
EnvironmentList
EnvironmentResponse
RetentionDetails

The retention details of the environment.

EnvironmentList

Name Type Description
value

EnvironmentResponse[]

EnvironmentResponse

Name Type Description
adminMode

string

The administrative mode of the environment.

azureRegion

string

The Azure region of the environment.

backgroundOperationsState

string

The background operations state of the environment.

createdDateTime

string (date-time)

The creation date and time of the environment.

dataverseId

string

The value of dataverseId property on the environment object.

deletedDateTime

string (date-time)

The deletion date and time of the environment.

displayName

string

The display name of the environment.

domainName

string

The domain name of the environment.

geo

string

The geographical region of the environment.

id

string

The value of id property on the environment object.

protectionLevel

string

The protection level of the environment.

retentionDetails

RetentionDetails

The retention details of the environment.

state

string

The state of the environment.

tenantId

string

The value of tenantId property on the environment object.

type

string

The type of environment.

url

string

The URL of the environment.

version

string

The version of the environment.

RetentionDetails

The retention details of the environment.

Name Type Description
availableFromDateTime

string (date-time)

The available from date and time of the environment.

retentionPeriod

string

The retention period of the environment.