Skip to main content
POST
/
uptime
/
status-pages
/
{statusPageId}
Update a status page
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",
  "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"
  ],
  "logo_light": "<string>",
  "logo_dark": "<string>",
  "favicon_light": "<string>",
  "favicon_dark": "<string>"
}
'
{
  "name": "Phare status",
  "subdomain": "example",
  "title": "Phare status",
  "description": "Status page of phare.io",
  "search_engine_indexed": true,
  "website_url": "https://phare.io",
  "components": [
    {
      "componentable_type": "uptime/monitor",
      "componentable_id": 123
    }
  ],
  "id": 1,
  "project_id": 1,
  "domain": "status.example.com",
  "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
  },
  "timeframe": 90,
  "subscription_channels": [
    "rss"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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"

Path Parameters

​
statusPageId
integer
required

ID of the status page to update

Body

application/json

Status page request

​
name
string

Status page name

Example:

"Phare status"

​
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"

​
title
string

Status page HTML title

Example:

"Phare status"

​
description
string

Status page HTML description

Example:

"Status page of phare.io"

​
search_engine_indexed
boolean

Whether search engines are allowed to index the page

Example:

true

​
website_url
string

URL to redirect users clicking the status page logo

Example:

"https://phare.io"

​
color_scheme
enum<string>

Choose the available color schemes for the status page

Available options:
all,
dark,
light
Example:

"all"

​
theme
object

Theme settings to customize the status page

​
components
Monitor component · object[]

List of components to show on the status page

​
timeframe
enum<integer>

Number of days of status and incident history to display.

Available options:
30,
60,
90
Example:

90

​
subscription_channels
enum<string>[]

List of active subscription channels

Maximum array length: 3
Available options:
rss,
atom,
slack
​
logo_light

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

​
logo_dark

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

​
favicon_light

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

​
favicon_dark

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

Response

Success, status page updated

​
name
string
required

Status page name

Example:

"Phare status"

​
subdomain
string
required

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

Example:

"example"

​
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"

​
components
Monitor component · object[]
required

List of components to show on the status page

​
id
integer

Status page ID

Example:

1

​
project_id
integer

Parent project ID

Example:

1

​
domain
string | null

Custom domain name for the status page

Example:

"status.example.com"

​
color_scheme
enum<string>

Choose the available color schemes for the status page

Available options:
all,
dark,
light
Example:

"all"

​
theme
object

Theme settings to customize the status page

​
timeframe
enum<integer>

Number of days of status and incident history to display.

Available options:
30,
60,
90
Example:

90

​
subscription_channels
enum<string>[]

List of active subscription channels

Maximum array length: 3
Available options:
rss,
atom,
slack
​
created_at
string<date-time>

Date of creation for the entity

​
updated_at
string<date-time>

Date of last update for the entity