GET
/
uptime
/
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",
      "colors": {
        "operational": "#16a34a",
        "degradedPerformance": "#fbbf24",
        "partialOutage": "#f59e0b",
        "majorOutage": "#ef4444",
        "maintenance": "#6366f1",
        "empty": "#d3d3d3"
      },
      "components": [
        {
          "componentable_type": "uptime/monitor",
          "componentable_id": 123
        }
      ],
      "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"
  }
}
Please be aware that the Phare API is currently in beta and is subject to change.

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 <token>'.

Query Parameters

​
page
integer
default:1

Page number to show

Example:

1

​
per_page
integer
default:20

Number of ressources to return per page

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

20

Response

200
application/json
Success, status pages retrieved
​
data
object[]
​
meta
object

Meta data for pagination

​
links
object

Links for pagination

Was this page helpful?

Suggest edits