Websites - Get Websites

Service:

Power Platform API

API Version:

2022-03-01-preview

List Power Pages websites.
Get a list of all the websites in your environment

GET https://api.powerplatform.com/powerpages/environments/{environmentId}/websites?api-version=2022-03-01-preview

With optional parameters:

GET https://api.powerplatform.com/powerpages/environments/{environmentId}/websites?skip={skip}&api-version=2022-03-01-preview

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	string
api-version	query	True	string	The API version
skip	query		string

Responses

Name	Type	Description
200 OK	ODataListWebsitesDto	Success
400 Bad Request	ErrorMessage	Bad Request
401 Unauthorized	ErrorMessage	Unauthorized

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
Details
Error
ErrorMessage
ODataListWebsitesDto
WebsiteDto

Details

Name	Type	Description
code	string	Error code
message	string	Error message
target	string	Target parameter

Error

Name	Type	Description
code	string	Error code
details	Details[]
message	string	Error message
target	string	Target parameter

ErrorMessage

Name	Type	Description
error	Error

ODataListWebsitesDto

Name	Type	Description
@odata.metadata	string
@odata.nextLink	string
value	WebsiteDto[]

WebsiteDto

Name	Type	Description
applicationUserAadAppId	string	Azure Active Directory (AAD) object unique identifier (ID)
createdOn	string	Website creation time in the ISO 8601 UTC format
customHostNames	string[]	Custom hostnames added for the website
dataverseInstanceUrl	string	Organization URL of the website
dataverseOrganizationId	string	Organization unique identifier (ID) of the website
environmentId	string	Environment unique identifier (ID) of the website
environmentName	string	Environment name of the website
id	string	Website unique identifier (ID)
isCustomErrorEnabled	boolean	Custom error enablement for Website
isEarlyUpgradeEnabled	boolean	Website eligibility for early upgrade
name	string	Website name
ownerId	string	User unique identifier (ID) of the website owner
packageInstallStatus	enum: InstallFailed InstallRequested InstallRetrying InstallScheduled Installed Installing None TemplateInstalled UninstallFailed UninstallRequested Uninstalled Uninstalling	Package installation status of the website
packageVersion	string	Package version of the website
selectedBaseLanguage	integer	Language unique identifier (ID) of the website - https://go.microsoft.com/fwlink/?linkid=2208135
siteVisibility	enum: private public	Website visibility status
status	enum: OperationComplete OperationFailed OperationInProgress OperationNotStarted	Website status
subdomain	string	Subdomain of website
suspendedWebsiteDeletingInDays	integer	Time (in days) to website deletion, if suspended
templateName	enum: DefaultPortalTemplate PowerPortals_BookMeeting PowerPortals_ProgramRegistration	Website template name
tenantId	string	Tenant unique identifier (ID) of the website
trialExpiringInDays	integer	Time (in days) to expiration of the website
type	enum: Production Trial	Application type of the website
websiteRecordId	string	Dataverse record unique identifier (ID) of the website
websiteUrl	string	Website URL