Skip to main content

Pages

Endpoints for managing and retrieving status page profiles and status data.

List All Pages​

Retrieve a list of all status pages associated with your account.

HTTP Method & URL: GET /pages

Request​

NameValueRequiredDescription
Acceptapplication/jsonYesExpected response format.

Responses​

Description: Success. Returns a list of pages.

Response Body: List<PageModel>

[
  {
    "StatusPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "Production Status Page",
    "Url": "https://status.example.com",
    "IsActive": true,
    "IsPublic": true,
    "IsDefault": true,
    "IsRestricted": false,
    "IsLayoutPlublished": true
  }
]

Private Status​

Retrieve private status page data.

HTTP Method & URL: GET /api/StatusPage/private

Authorization: Requires X-API-KEY

Request​

NameValueRequiredDescription
X-API-KEYstringYesYour unique API key.

Responses​

Description: Success. Returns private status data.

Response Body: ApiResponse<StatusPageResponseModel>

Audience Specific Status​

Retrieve status page data for a specific audience.

HTTP Method & URL: GET /api/StatusPage/audience-specific/{guid}

Request​

  • guid: (Guid) The unique ID of the audience.
  • userId: (Optional Guid) The ID of the user.

Responses​

Description: Success.

Response Body: ApiResponse<StatusPageResponseModel>

Check Access​

Check if a user has access to a specific status page.

HTTP Method & URL: GET /api/StatusPage/{pageName}/check-access

Responses​

Description: Success. Returns access status.

{
  "IsActive": true,
  "IsPublic": true,
  "HasAccess": true
}

Active Announcements​

Retrieve all currently active announcements.

HTTP Method & URL: GET /api/StatusPage/ActiveAnnouncement

Responses​

Description: Success. Returns a list of active incidents/announcements.

Response Body: ApiResponse<List<IncidentInfo>>

Retrieve incident history with filters.

HTTP Method & URL: POST /api/StatusPage/statushistory

Request​

Body: IncidentHistorySearchModel

Responses​

Description: Success. Returns incident history.

Response Body: ApiResponse<StatusPageIncidentHistoryResponseModel>

Uptime Data by Date​

Retrieve uptime statistics for a specific date range.

HTTP Method & URL: POST /api/StatusPage/getUptimeDataByDate

Request​

Body: DateRequest

  • Days: (Int) Number of days of data to retrieve.
{
  "Days": 90
}

Responses​

Description: Success. Returns uptime data.

Uptime Reports​

Generate detailed uptime reports.

HTTP Method & URL: POST /api/StatusPage/GetUptimeReports

Request​

NameValueRequiredDescription
Content-Typeapplication/jsonYesSending JSON data.

Responses​

Description: Success. Returns detailed uptime metrics.

Response Body: ApiResponse<ReportsModel>