Skip to main content
GET
/
uptime
/
status-pages
List status pages
curl --request GET \
  --url https://api.phare.io/uptime/status-pages \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "project_id": 1,
      "name": "Phare status",
      "subdomain": "example",
      "domain": "status.example.com",
      "title": "Phare status",
      "description": "Status page of phare.io",
      "search_engine_indexed": true,
      "website_url": "https://phare.io",
      "color_scheme": "all",
      "theme": {
        "light": {
          "operational": "#16a34a",
          "degraded_performance": "#fbbf24",
          "partial_outage": "#f59e0b",
          "major_outage": "#ef4444",
          "maintenance": "#6366f1",
          "empty": "#d3d3d3",
          "background": "#ffffff",
          "foreground": "#000000",
          "foreground_muted": "#737373",
          "background_card": "#fafafa"
        },
        "dark": {
          "operational": "#16a34a",
          "degraded_performance": "#fbbf24",
          "partial_outage": "#f59e0b",
          "major_outage": "#ef4444",
          "maintenance": "#6366f1",
          "empty": "#d3d3d3",
          "background": "#111111",
          "foreground": "#ffffff",
          "foreground_muted": "#959595",
          "background_card": "#1a1a1a"
        },
        "rounded": true,
        "border_width": 2
      },
      "components": [
        {
          "componentable_type": "uptime/monitor",
          "componentable_id": 123
        }
      ],
      "timeframe": 90,
      "subscription_channels": [
        "rss"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "from": 11,
    "to": 20,
    "per_page": 100,
    "path": "https://api.phare.io/{resource}?page=2"
  },
  "links": {
    "first": "https://api.phare.io/{resource}?page=2",
    "last": "https://api.phare.io/{resource}?page=10",
    "prev": "https://api.phare.io/{resource}?page=1",
    "next": "https://api.phare.io/{resource}?page=1"
  }
}

Authorizations

Authorization
string
header
required

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.

Headers

X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Query Parameters

page
integer
default:1

Page number to show

Example:

1

per_page
integer
default:20

Number of resources to return per page

Required range: 1 <= x <= 100
Example:

20

Response

Success, status pages retrieved

data
object[]
meta
object

Meta data for pagination

Links for pagination