POST
/
uptime
/
status-pages
/
{statusPageId}
curl --request POST \
  --url https://api.phare.io/uptime/status-pages/{statusPageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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
    }
  ],
  "logo": "<string>",
  "favicon": "<string>"
}'
{
  "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"
}
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 update

Body

application/json
Status page request
​
name
string
required

Status page name

Example:

"Phare status"

​
title
string
required

Status page HTML title

Example:

"Phare status"

​
description
string
required

Status page HTML description

Example:

"Status page of phare.io"

​
search_engine_indexed
boolean
required

Whether search engines are allowed to index the page

Example:

true

​
website_url
string
required

URL to redirect users clicking the status page logo

Example:

"https://phare.io"

​
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

Example:

"example"

​
domain
string | null

Custom domain name for the status page

Example:

"status.example.com"

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

​
favicon

Manage the favicon of the status page (accepted formats: ico / png / svg)

Response

200
application/json
Success, status page updated
​
name
string
required

Status page name

Example:

"Phare status"

​
title
string
required

Status page HTML title

Example:

"Phare status"

​
description
string
required

Status page HTML description

Example:

"Status page of phare.io"

​
search_engine_indexed
boolean
required

Whether search engines are allowed to index the page

Example:

true

​
website_url
string
required

URL to redirect users clicking the status page logo

Example:

"https://phare.io"

​
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

Example:

1

​
project_id
number

Parent project ID

Example:

1

​
subdomain
string

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

Example:

"example"

​
domain
string | null

Custom domain name for the status page

Example:

"status.example.com"

​
created_at
string

Date of creation for the entity

​
updated_at
string

Date of last update for the entity

Was this page helpful?

Suggest edits