Status Pages: Retrieve All

This documentation entry provides a comprehensive guide to using the "Retrieve All" status pages endpoint, including all relevant details about the request, response, and data structures.

Endpoint

GET /api/status-pages/

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

Request

HTTP Request

GET https://uptimekeep.com/api/status-pages/

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Query Parameters

Parameter	Type	Description	Default Value
page	Integer	(Optional) The page number to retrieve.	1
results_per_page	Integer	(Optional) Number of results per page. Allowed values: 10, 25, 50, 100, 250, 500, 1000.	25

Example of a request:

curl --request GET \
--url 'https://uptimekeep.com/api/status-pages/' \
--header 'Authorization: Bearer {api_key}'

Response

A successful response returns a JSON object with the list of status pages and associated metadata.

Response Example

{
    "data": [
        {
            "id": 1,
            "domain_id": 0,
            "monitors_ids": [1,2,3],
            "project_id": 0,
            "url": "example",
            "full_url": "https://uptimekeep.com/s/example/",
            "name": "Example",
            "description": "This is just a simple description for the example status page 👋.",
            "socials": {
                "facebook": "example",
                "instagram": "example",
                "twitter": "example",
                "email": "",
                "website": "https://example.com/"
            },
            "logo_url": "",
            "favicon_url": "",
            "password": false,
            "timezone": "UTC",
            "custom_js": "",
            "custom_css": "",
            "pageviews": 50,
            "is_se_visible": true,
            "is_removed_branding": false,
            "is_enabled": true,
            "datetime": "2021-02-16 10:47:34"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimekeep.com/api/status-pages?&page=1",
        "last": "https://uptimekeep.com/api/status-pages?&page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimekeep.com/api/status-pages?&page=1"
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the status page.
domain_id	Integer	ID of the associated domain (if applicable).
monitors_ids	Array	List of monitor IDs associated with the status page.
project_id	Integer	ID of the associated project (if applicable).
url	String	URL slug for the status page.
full_url	String	Full URL of the status page.
name	String	Name of the status page.
description	String	Description of the status page.
socials	Object	Social media links and other external URLs (see below for details).
logo_url	String	URL of the logo used on the status page.
favicon_url	String	URL of the favicon used on the status page.
password	Boolean	Indicates if the status page is password-protected.
timezone	String	Timezone for the status page.
custom_js	String	Custom JavaScript added to the status page.
custom_css	String	Custom CSS added to the status page.
pageviews	Integer	Number of pageviews for the status page.
is_se_visible	Boolean	Indicates if the status page is visible to search engines.
is_removed_branding	Boolean	Indicates if branding has been removed from the status page.
is_enabled	Boolean	Indicates if the status page is currently active.
datetime	String	Timestamp when the status page was created (in YYYY-MM-DD HH:MM:SS format).

Socials Object

Field	Type	Description
facebook	String	Facebook profile or page link.
instagram	String	Instagram profile link.
twitter	String	Twitter profile link.
email	String	Email address associated with the status page.
website	String	External website URL.

Meta Object

Field	Type	Description
page	Integer	Current page number of the results.
results_per_page	Integer	Number of results per page.
total	Integer	Total number of status pages.
total_pages	Integer	Total number of pages available based on the current query.

Links Object

Field	Type	Description
first	String	URL of the first page of results.
last	String	URL of the last page of results.
next	String	URL of the next page of results (if applicable).
prev	String	URL of the previous page of results (if applicable).
self	String	URL of the current page of results.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code.