POST
/
uptime
/
status-pages
Please be aware that the Phare API is currently in beta and is subject to change.

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required

Status page name

title
string
required

Status page HTML title

description
string
required

Status page HTML description

search_engine_indexed
boolean
required

Whether search engines are allowed to index the page

website_url
string
required

URL to redirect users clicking the status page logo

colors
object
required

Colors to customize the status page

components
object[]
required

List of components to show on the status page

subdomain
string

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

domain
string | null

Custom domain name for the status page

logo

Manage the logo of the status page (accepted formats: png/jpeg/svg)

Response

201 - application/json
name
string
required

Status page name

title
string
required

Status page HTML title

description
string
required

Status page HTML description

search_engine_indexed
boolean
required

Whether search engines are allowed to index the page

website_url
string
required

URL to redirect users clicking the status page logo

colors
object
required

Colors to customize the status page

components
object[]
required

List of components to show on 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

domain
string | null

Custom domain name for the status page

logo_url
string | null

URL of the uploaded logo

created_at
string

Date of creation for the entity

updated_at
string

Date of last update for the entity

Was this page helpful?

Get a status pageUpdate a status page