Overview
Public status pages provide an overview of your website’s uptime and performance. These can be shared to a wider audience, such as customers or stakeholders, to show real-time availability information and promote transparency in your web services.
Use cases
Use the PublicStatusPage API to:
- Manage public status pages — create, update, and delete public status pages.
- Customize public status page settings — personalize your page by setting the title, background color, sorting options, and more.
- View public status pages in bulk — see real-time status and details for multiple pages at once for easier analysis, tracking, and reporting.
Prerequisites
Before using the Public status page API, make sure that you have:
Public status page API fields
The PublicStatusPage API contains various API fields:
| Field name | Description |
|---|---|
PublicDashboardGuid |
The unique identifier of the public status page. |
Name |
The name of the public status page. |
IsPublished |
Indicates true if the public status page is published and available to the public. Otherwise, false. |
PresetPeriodType |
The period for which the data is shown. Available filtering options include:
|
CustomizationInfo |
Contains different fields for modifying and personalizing your public status page. For more information, refer to the CustomizationInfo section below.
|
SlaGuid |
The unique identifier of the SLA. If the published status page contains data that is based on an SLA, the selected SLA will be used. |
MonitorGuids |
The unique identifier of the monitors showed on the public status page. |
MonitorGroupGuids |
The unique identifier of the monitor groups showed on the public status page. |
CustomizationInfo fields
You can
customize the display settings of your public status page using the CustomizationInfo fields:
| CustomizationInfo field name | Description |
|---|---|
MainColor |
The hexadecimal color value used for your public status page theme. |
BackgroundColor |
The hexadecimal color value used as the background of your public status page. |
TextColor |
The hexadecimal color value of the text of your public status page. |
SortColumnsNewToOld |
Indicates true if the columns are sorted from newest to oldest. Otherwise, false. |
SortRowsProperty |
Defines how rows are sorted. Possible values are Alphabetical (by monitor name) or ByStatus (by monitor status, with errors first). |
CommentTitle |
The title displayed on the public status page banner. |
CommentText |
The message displayed on the banner to inform users about the current status or issues on the public status page. |
AutoRefresh |
Indicates true if the public status page automatically refreshes and retrieves data. Otherwise, false. |
Public status page API endpoints
The Public status page API provides the following endpoints for managing your monitors:
Manage monitors
| Method | Endpoint | Description |
|---|---|---|
GET |
/PublicStatusPage |
Retrieve a list of all public status pages in your account. |
POST |
/PublicStatusPage |
Create a new public status page using the given configuration. |
GET |
/PublicStatusPage/{publicStatusPageGuid} |
Retrieve the specified public status page and its configuration. |
PATCH |
/PublicStatusPage/{publicStatusPageGuid} |
Update selected fields of the public status page definition. |
PUT |
/PublicStatusPage/{publicStatusPageGuid} |
Update all fields of the public status page definition. |
DELETE |
/PublicStatusPage/{publicStatusPageGuid} |
Remove the specified public status page from your account. |
For detailed request and response formats and interactive API testing, refer to the Uptrends Public status page API documentation.
Troubleshooting
This section covers common HTTP errors and troubleshooting steps for the Public status page API.
Common errors
Common HTTP status codes and their descriptions:
| Status Code | Description |
|---|---|
| 200 | OK — request successful |
| 204 | No content — the request completed successfully and no response was returned. This is for DELETE, PUT, PATCH, and POST requests. |
| 400 | Bad request — invalid request parameters or missing required fields. |
| 401 | Unauthorized — invalid or missing authentication credentials. |
| 403 | Forbidden — permission denied. |
| 404 | Not Found — the specified GUID does not exist. |
| 500 | Internal Server Error — a server-side error occurred. |
General troubleshooting guide
Ensure that you:
- Always validate your request data before sending API calls.
- Use appropriate HTTP methods for each operation.
For further assistance, please reach out to our Support team.
Additional articles
For more details, refer to the following articles:
- Uptrends Public status page API documentation — an interactive API documentation with detailed endpoint specifications.
- API changelog - for latest API updates and deprecation notices.