Skip to main content

Admin Status Page

Admin Status Page Intro

Advanced endpoints for managing status page instances, assignments, and customization.

X-API-KEY Required for all endpoints in this section.

List & Create​

List All Admin Status Pages​

Retrieve all status pages managed by the organization.

HTTP Method & URL: GET /api/AdminStatusPage

Request​

NameValueRequiredDescription
X-API-KEYstringYesYour unique API key.

Responses​

Description: Success. Returns all status pages.

Response Body: ApiResponse<List<AdminStatusPageModel>>

Create Status Page​

Create a new status page instance.

HTTP Method & URL: POST /api/AdminStatusPage

Request​

Body: AdminStatusPageModel

Responses​

Description: Success. Returns the ID of the new page.

Response Body: ApiResponse<Guid>

Detailed Management​

Get Page by ID​

HTTP Method & URL: GET /api/AdminStatusPage/{id}

Delete Page​

HTTP Method & URL: DELETE /api/AdminStatusPage/{id}

Responses​

Description: Success.

Assign Users​

Assign multiple users to a status page for audience-specific viewing.

HTTP Method & URL: POST /api/AdminStatusPage/{id}/assign-users

Request​

Body: List<string> (Array of User IDs)

["3fa85f64-5717-4562-b3fc-2c963f66afa0", "3fa85f64-5717-4562-b3fc-2c963f66afb1"]

Responses​

Description: Success. Users assigned.

Toggle Page Status​

Enable or disable a status page.

HTTP Method & URL: PATCH /api/AdminStatusPage/{id}/status

Request​

Body: JSON object

{ "isActive": true }

Responses​

Description: Success.

Customization & Regions​

  • POST /api/AdminStatusPage/customize/publish: Publish layout customizations.
  • GET /api/AdminStatusPage/custom/{statusPageId}: Get custom layout data.
  • GET /api/AdminStatusPage/regions-zones/{componentId}: Get region and zone data for a component.

Responses​

Description: Success.