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",
  "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
    }
  ],
  "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": [],
  "access_ips": [
    "45.129.56.0/24"
  ],
  "logo_light": "<string>",
  "logo_dark": "<string>",
  "favicon_light": "<string>",
  "favicon_dark": "<string>",
  "access_token": "secret",
  "access_password": "secret"
}
'

import requests

url = "https://api.phare.io/uptime/status-pages"

payload = {
    "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
        }
    ],
    "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": [],
    "access_ips": ["45.129.56.0/24"],
    "logo_light": "<string>",
    "logo_dark": "<string>",
    "favicon_light": "<string>",
    "favicon_dark": "<string>",
    "access_token": "secret",
    "access_password": "secret"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}],
    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: [],
    access_ips: ['45.129.56.0/24'],
    logo_light: '<string>',
    logo_dark: '<string>',
    favicon_light: '<string>',
    favicon_dark: '<string>',
    access_token: 'secret',
    access_password: 'secret'
  })
};

fetch('https://api.phare.io/uptime/status-pages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.phare.io/uptime/status-pages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
        ]
    ],
    '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' => [
        
    ],
    'access_ips' => [
        '45.129.56.0/24'
    ],
    'logo_light' => '<string>',
    'logo_dark' => '<string>',
    'favicon_light' => '<string>',
    'favicon_dark' => '<string>',
    'access_token' => 'secret',
    'access_password' => 'secret'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.phare.io/uptime/status-pages"

	payload := strings.NewReader("{\n  \"name\": \"Phare status\",\n  \"subdomain\": \"example\",\n  \"title\": \"Phare status\",\n  \"description\": \"Status page of phare.io\",\n  \"search_engine_indexed\": true,\n  \"website_url\": \"https://phare.io\",\n  \"components\": [\n    {\n      \"componentable_type\": \"uptime/monitor\",\n      \"componentable_id\": 123\n    }\n  ],\n  \"domain\": \"status.example.com\",\n  \"color_scheme\": \"all\",\n  \"theme\": {\n    \"light\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#ffffff\",\n      \"foreground\": \"#000000\",\n      \"foreground_muted\": \"#737373\",\n      \"background_card\": \"#fafafa\"\n    },\n    \"dark\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#111111\",\n      \"foreground\": \"#ffffff\",\n      \"foreground_muted\": \"#959595\",\n      \"background_card\": \"#1a1a1a\"\n    },\n    \"rounded\": true,\n    \"border_width\": 2\n  },\n  \"timeframe\": 90,\n  \"subscription_channels\": [],\n  \"access_ips\": [\n    \"45.129.56.0/24\"\n  ],\n  \"logo_light\": \"<string>\",\n  \"logo_dark\": \"<string>\",\n  \"favicon_light\": \"<string>\",\n  \"favicon_dark\": \"<string>\",\n  \"access_token\": \"secret\",\n  \"access_password\": \"secret\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.phare.io/uptime/status-pages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Phare status\",\n  \"subdomain\": \"example\",\n  \"title\": \"Phare status\",\n  \"description\": \"Status page of phare.io\",\n  \"search_engine_indexed\": true,\n  \"website_url\": \"https://phare.io\",\n  \"components\": [\n    {\n      \"componentable_type\": \"uptime/monitor\",\n      \"componentable_id\": 123\n    }\n  ],\n  \"domain\": \"status.example.com\",\n  \"color_scheme\": \"all\",\n  \"theme\": {\n    \"light\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#ffffff\",\n      \"foreground\": \"#000000\",\n      \"foreground_muted\": \"#737373\",\n      \"background_card\": \"#fafafa\"\n    },\n    \"dark\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#111111\",\n      \"foreground\": \"#ffffff\",\n      \"foreground_muted\": \"#959595\",\n      \"background_card\": \"#1a1a1a\"\n    },\n    \"rounded\": true,\n    \"border_width\": 2\n  },\n  \"timeframe\": 90,\n  \"subscription_channels\": [],\n  \"access_ips\": [\n    \"45.129.56.0/24\"\n  ],\n  \"logo_light\": \"<string>\",\n  \"logo_dark\": \"<string>\",\n  \"favicon_light\": \"<string>\",\n  \"favicon_dark\": \"<string>\",\n  \"access_token\": \"secret\",\n  \"access_password\": \"secret\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.phare.io/uptime/status-pages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Phare status\",\n  \"subdomain\": \"example\",\n  \"title\": \"Phare status\",\n  \"description\": \"Status page of phare.io\",\n  \"search_engine_indexed\": true,\n  \"website_url\": \"https://phare.io\",\n  \"components\": [\n    {\n      \"componentable_type\": \"uptime/monitor\",\n      \"componentable_id\": 123\n    }\n  ],\n  \"domain\": \"status.example.com\",\n  \"color_scheme\": \"all\",\n  \"theme\": {\n    \"light\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#ffffff\",\n      \"foreground\": \"#000000\",\n      \"foreground_muted\": \"#737373\",\n      \"background_card\": \"#fafafa\"\n    },\n    \"dark\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#111111\",\n      \"foreground\": \"#ffffff\",\n      \"foreground_muted\": \"#959595\",\n      \"background_card\": \"#1a1a1a\"\n    },\n    \"rounded\": true,\n    \"border_width\": 2\n  },\n  \"timeframe\": 90,\n  \"subscription_channels\": [],\n  \"access_ips\": [\n    \"45.129.56.0/24\"\n  ],\n  \"logo_light\": \"<string>\",\n  \"logo_dark\": \"<string>\",\n  \"favicon_light\": \"<string>\",\n  \"favicon_dark\": \"<string>\",\n  \"access_token\": \"secret\",\n  \"access_password\": \"secret\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "is_private": false,
  "access_password_enabled": false,
  "access_token_enabled": false,
  "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": [],
  "access_ips": [
    "45.129.56.0/24"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "Unauthorized"
}

{
  "message": "The platform:write permission is required to perform this action."
}

{
  "message": "<string>",
  "errors": {
    "key": [
      "The key field is required"
    ]
  }
}

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",
  "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
    }
  ],
  "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": [],
  "access_ips": [
    "45.129.56.0/24"
  ],
  "logo_light": "<string>",
  "logo_dark": "<string>",
  "favicon_light": "<string>",
  "favicon_dark": "<string>",
  "access_token": "secret",
  "access_password": "secret"
}
'

import requests

url = "https://api.phare.io/uptime/status-pages"

payload = {
    "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
        }
    ],
    "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": [],
    "access_ips": ["45.129.56.0/24"],
    "logo_light": "<string>",
    "logo_dark": "<string>",
    "favicon_light": "<string>",
    "favicon_dark": "<string>",
    "access_token": "secret",
    "access_password": "secret"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}],
    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: [],
    access_ips: ['45.129.56.0/24'],
    logo_light: '<string>',
    logo_dark: '<string>',
    favicon_light: '<string>',
    favicon_dark: '<string>',
    access_token: 'secret',
    access_password: 'secret'
  })
};

fetch('https://api.phare.io/uptime/status-pages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.phare.io/uptime/status-pages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
        ]
    ],
    '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' => [
        
    ],
    'access_ips' => [
        '45.129.56.0/24'
    ],
    'logo_light' => '<string>',
    'logo_dark' => '<string>',
    'favicon_light' => '<string>',
    'favicon_dark' => '<string>',
    'access_token' => 'secret',
    'access_password' => 'secret'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.phare.io/uptime/status-pages"

	payload := strings.NewReader("{\n  \"name\": \"Phare status\",\n  \"subdomain\": \"example\",\n  \"title\": \"Phare status\",\n  \"description\": \"Status page of phare.io\",\n  \"search_engine_indexed\": true,\n  \"website_url\": \"https://phare.io\",\n  \"components\": [\n    {\n      \"componentable_type\": \"uptime/monitor\",\n      \"componentable_id\": 123\n    }\n  ],\n  \"domain\": \"status.example.com\",\n  \"color_scheme\": \"all\",\n  \"theme\": {\n    \"light\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#ffffff\",\n      \"foreground\": \"#000000\",\n      \"foreground_muted\": \"#737373\",\n      \"background_card\": \"#fafafa\"\n    },\n    \"dark\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#111111\",\n      \"foreground\": \"#ffffff\",\n      \"foreground_muted\": \"#959595\",\n      \"background_card\": \"#1a1a1a\"\n    },\n    \"rounded\": true,\n    \"border_width\": 2\n  },\n  \"timeframe\": 90,\n  \"subscription_channels\": [],\n  \"access_ips\": [\n    \"45.129.56.0/24\"\n  ],\n  \"logo_light\": \"<string>\",\n  \"logo_dark\": \"<string>\",\n  \"favicon_light\": \"<string>\",\n  \"favicon_dark\": \"<string>\",\n  \"access_token\": \"secret\",\n  \"access_password\": \"secret\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.phare.io/uptime/status-pages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Phare status\",\n  \"subdomain\": \"example\",\n  \"title\": \"Phare status\",\n  \"description\": \"Status page of phare.io\",\n  \"search_engine_indexed\": true,\n  \"website_url\": \"https://phare.io\",\n  \"components\": [\n    {\n      \"componentable_type\": \"uptime/monitor\",\n      \"componentable_id\": 123\n    }\n  ],\n  \"domain\": \"status.example.com\",\n  \"color_scheme\": \"all\",\n  \"theme\": {\n    \"light\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#ffffff\",\n      \"foreground\": \"#000000\",\n      \"foreground_muted\": \"#737373\",\n      \"background_card\": \"#fafafa\"\n    },\n    \"dark\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#111111\",\n      \"foreground\": \"#ffffff\",\n      \"foreground_muted\": \"#959595\",\n      \"background_card\": \"#1a1a1a\"\n    },\n    \"rounded\": true,\n    \"border_width\": 2\n  },\n  \"timeframe\": 90,\n  \"subscription_channels\": [],\n  \"access_ips\": [\n    \"45.129.56.0/24\"\n  ],\n  \"logo_light\": \"<string>\",\n  \"logo_dark\": \"<string>\",\n  \"favicon_light\": \"<string>\",\n  \"favicon_dark\": \"<string>\",\n  \"access_token\": \"secret\",\n  \"access_password\": \"secret\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.phare.io/uptime/status-pages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Phare status\",\n  \"subdomain\": \"example\",\n  \"title\": \"Phare status\",\n  \"description\": \"Status page of phare.io\",\n  \"search_engine_indexed\": true,\n  \"website_url\": \"https://phare.io\",\n  \"components\": [\n    {\n      \"componentable_type\": \"uptime/monitor\",\n      \"componentable_id\": 123\n    }\n  ],\n  \"domain\": \"status.example.com\",\n  \"color_scheme\": \"all\",\n  \"theme\": {\n    \"light\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#ffffff\",\n      \"foreground\": \"#000000\",\n      \"foreground_muted\": \"#737373\",\n      \"background_card\": \"#fafafa\"\n    },\n    \"dark\": {\n      \"operational\": \"#16a34a\",\n      \"degraded_performance\": \"#fbbf24\",\n      \"partial_outage\": \"#f59e0b\",\n      \"major_outage\": \"#ef4444\",\n      \"maintenance\": \"#6366f1\",\n      \"empty\": \"#d3d3d3\",\n      \"background\": \"#111111\",\n      \"foreground\": \"#ffffff\",\n      \"foreground_muted\": \"#959595\",\n      \"background_card\": \"#1a1a1a\"\n    },\n    \"rounded\": true,\n    \"border_width\": 2\n  },\n  \"timeframe\": 90,\n  \"subscription_channels\": [],\n  \"access_ips\": [\n    \"45.129.56.0/24\"\n  ],\n  \"logo_light\": \"<string>\",\n  \"logo_dark\": \"<string>\",\n  \"favicon_light\": \"<string>\",\n  \"favicon_dark\": \"<string>\",\n  \"access_token\": \"secret\",\n  \"access_password\": \"secret\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "is_private": false,
  "access_password_enabled": false,
  "access_token_enabled": false,
  "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": [],
  "access_ips": [
    "45.129.56.0/24"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "Unauthorized"
}

{
  "message": "The platform:write permission is required to perform this action."
}

{
  "message": "<string>",
  "errors": {
    "key": [
      "The key field is required"
    ]
  }
}

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"

Body

application/json

Status page request

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

Show child attributes

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

Show child attributes

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

access_ips

string[] | null

List of IP addresses or CIDR ranges allowed to access the status page. Requires an active Scale plan subscription.

Required array length: 1 - 50 elements

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)

access_token

string | null

Token to restrict access to the status page. Requires an active Scale plan subscription.

Required string length: 8 - 500

Example:

"secret"

access_password

string | null

Password to restrict access to the status page. Requires an active Scale plan subscription.

Required string length: 8 - 500

Example:

"secret"

Response

Success, status page created

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

Show child attributes

integer

Status page ID

Example:

1

project_id

integer

Parent project ID

Example:

1

is_private

boolean

Whether the status page requires authentication to access

Example:

false

access_password_enabled

boolean

Whether the status page is protected by a password. Requires an active Scale plan subscription.

Example:

false

access_token_enabled

boolean

Whether the status page is protected by a secret token. Requires an active Scale plan subscription.

Example:

false

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

Show child attributes

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

access_ips

string[] | null

List of IP addresses or CIDR ranges allowed to access the status page. Requires an active Scale plan subscription.

Required array length: 1 - 50 elements

created_at

string<date-time>

Date of creation for the entity

updated_at

string<date-time>

Date of last update for the entity

Last modified on February 8, 2026

Get a status page Update a status page

API Documentation

Platform

Uptime

Create a status page

Authorizations

Headers

Body

Response