GET
/
uptime
/
status-pages
/
{statusPageId}
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>'.

Path Parameters

​
statusPageId
integer
required

ID of the status page to show

Response

200 - application/json
​
colors
object
required

Colors to customize the status page

​
components
object[]
required

List of components to show on the status page

​
description
string
required

Status page HTML description

​
name
string
required

Status page name

​
search_engine_indexed
boolean
required

Whether search engines are allowed to index the page

​
title
string
required

Status page HTML title

​
website_url
string
required

URL to redirect users clicking the status page logo

​
created_at
string

Date of creation for the entity

​
domain
string | null

Custom domain name for the status page

​
id
number

Status page ID

​
project_id
number

Parent project ID

​
subdomain
string

Subdomain name for the status page, hosted on a phare.io domain: {subdomain}.status.phare.io

​
updated_at
string

Date of last update for the entity

Was this page helpful?

Suggest edits
List status pagesCreate a status page