Skip to main content

Search power alert configurations

Request

Returns a paginated list of power alert configurations matching the specified filters. Results can be filtered by IBX and state. Both limit and offset are required to control pagination.

Security
BearerAuth
Query
ibxArray of strings

List of IBX codes to filter configurations (comma-separated)

Example:ibx=SV5,NY1
stateArray of strings

List of states to filter configurations (comma-separated). Possible values - ACTIVE, PAUSED, DELETED

Items Enum:"ACTIVE""PAUSED""DELETED"
Example:state=ACTIVE
limitintegerrequired

Number of records to retrieve per request

Example:limit=100
offsetintegerrequired

Record number to start retrieval from (0..N)

Example:offset=0
Payload
// No request payload

Responses

OK

Bodyapplication/json
dataArray of objects(AlertConfigurationReadModel)

Array of power alert configurations

paginationobject

Pagination metadata

Response
{ "data": [ { … } ], "pagination": { "offset": 0, "limit": 100, "total": 15 } }
Was this page helpful?