Websites - Get Exceptions

Service:: Power Platform API

API Version:: 2024-10-01

Lists the admin exceptions for a tenant.
Lists the tenant's exception state rows (optionally filtered by exception type) with the derived lifecycle status.

GET https://api.powerplatform.com/powerpages/environments/{environmentId}/exceptions/list?api-version=2024-10-01

With optional parameters:

GET https://api.powerplatform.com/powerpages/environments/{environmentId}/exceptions/list?exceptionType=WebApiStarRetirement&api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
environmentId	path	True	string	The environment ID.
api-version	query	True	string	The API version.
exceptionType	query		string	Optional exception scenario discriminator to filter by, e.g. "WebApiStarRetirement".

Responses

Name	Type	Description
200 OK	ExceptionView[]	OK
400 Bad Request	ErrorMessage	Bad Request
401 Unauthorized	ErrorMessage	Unauthorized
404 Not Found	ErrorMessage	Not Found

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
ExceptionType	Exception scenario discriminator identifying which admin exception ("break-glass") scenario a grant, revoke, or query targets.
ExceptionView

Details

Object

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

Error

Object

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

ErrorMessage

Object

Name	Type	Description
error	Error

ExceptionType

Enumeration

Exception scenario discriminator identifying which admin exception ("break-glass") scenario a grant, revoke, or query targets.

Value	Description
WebApiStarRetirement

ExceptionView

Object

Name	Type	Description
created	string (date-time)	UTC time the exception was created.
exceptionType	ExceptionType	Exception scenario discriminator identifying which admin exception ("break-glass") scenario a grant, revoke, or query targets.
expirationDate	string (date-time)	UTC expiry of the exception.
portalId	string	Website unique identifier (ID).
status	string	Derived lifecycle status of the exception.