API Documentation
Platform
- GETGet API info
- Alert Rules
Status Pages
Create a status page
Create a status page
POST
/
uptime
/
status-pages
curl --request POST \
--url https://api.phare.io/uptime/status-pages \
--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
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
Status page request
The body is of type object
.
Response
201
application/json
Success, status page created
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.phare.io/uptime/status-pages \
--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"
}
Assistant
Responses are generated using AI and may contain mistakes.