Create a status page

curl --request POST \
  --url https://api.phare.io/uptime/status-pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Phare status",
  "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
    }
  ],
  "subdomain": "example",
  "domain": "status.example.com",
  "timeframe": 90,
  "subscription_channels": [
    "rss"
  ],
  "logo": "<string>",
  "favicon": "<string>"
}
'

{
  "name": "Phare status",
  "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
    }
  ],
  "id": 1,
  "project_id": 1,
  "subdomain": "example",
  "domain": "status.example.com",
  "timeframe": 90,
  "subscription_channels": [
    "rss"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

POST

uptime

status-pages

Create a status page

curl --request POST \
  --url https://api.phare.io/uptime/status-pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Phare status",
  "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
    }
  ],
  "subdomain": "example",
  "domain": "status.example.com",
  "timeframe": 90,
  "subscription_channels": [
    "rss"
  ],
  "logo": "<string>",
  "favicon": "<string>"
}
'

{
  "name": "Phare status",
  "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
    }
  ],
  "id": 1,
  "project_id": 1,
  "subdomain": "example",
  "domain": "status.example.com",
  "timeframe": 90,
  "subscription_channels": [
    "rss"
  ],
  "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 '.

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

Show child attributes

colors.operational

string

Example:

"#16a34a"

colors.degradedPerformance

string

Example:

"#fbbf24"

colors.partialOutage

string

Example:

"#f59e0b"

colors.majorOutage

string

Example:

"#ef4444"

colors.maintenance

string

Example:

"#6366f1"

colors.empty

string

Example:

"#d3d3d3"

components

Monitor component · object[]

required

List of components to show on the status page

Show child attributes

components.componentable_type

enum<string>

required

Available options:

uptime/monitor

components.componentable_id

integer

required

ID of the monitor to show

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"

timeframe

enum<number>

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: 2

Available options:

rss,

atom

logo

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

Success, status page created

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

Show child attributes

colors.operational

string

Example:

"#16a34a"

colors.degradedPerformance

string

Example:

"#fbbf24"

colors.partialOutage

string

Example:

"#f59e0b"

colors.majorOutage

string

Example:

"#ef4444"

colors.maintenance

string

Example:

"#6366f1"

colors.empty

string

Example:

"#d3d3d3"

components

Monitor component · object[]

required

List of components to show on the status page

Show child attributes

components.componentable_type

enum<string>

required

Available options:

uptime/monitor

components.componentable_id

integer

required

ID of the monitor to show

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"

timeframe

enum<number>

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: 2

Available options:

rss,

atom

created_at

string<date-time>

Date of creation for the entity

updated_at

string<date-time>

Date of last update for the entity

Get a status page Update a status page

⌘I

API Documentation

Platform

Uptime

Create a status page

Authorizations

Body

Response