PHphare
Status Pages

List status pages

Changed on

Get a paginated list of status pages

get/uptime/status-pages

Request

Query parameters

tagstring

Filter status pages by tag. Can be specified multiple times to only return status pages having all the given tags.

pageinteger
Example:1

Page number to show

per_pageinteger
Example:20

Number of resources to return per page

Headers

X-Phare-Project-Idinteger
Example:1

A project header is required when using an organization-scoped API key.

X-Phare-Project-Slugstring
Example:luminous-guiding-tower

A project header is required when using an organization-scoped API key.

Response

Success, status pages retrieved

Example response

{
  "data": [
    {
      "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",
      "color_scheme": "all",
      "theme": {
        "light": {
          "operational": "#16a34a",
          "degraded_performance": "#fbbf24",
          "partial_outage": "#f59e0b",
          "major_outage": "#ef4444",
          "maintenance": "#6366f1",
          "empty": "#d3d3d3",
          "background": "#ffffff",
          "border": "#e5e5e5",
          "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",
          "border": "#3f3f46",
          "foreground": "#ffffff",
          "foreground_muted": "#959595",
          "background_card": "#1a1a1a"
        },
        "rounded": true,
        "border_width": 2
      },
      "timeframe": 90,
      "show_response_times": true,
      "timezone": "Europe/Paris",
      "access_ips": [
        "45.129.56.0/24"
      ],
      "tags": [
        "environment:production"
      ]
    }
  ],
  "meta": {
    "current_page": 2,
    "from": 11,
    "to": 20,
    "per_page": 100,
    "path": "https://api.phare.io/{resource}?page=2"
  },
  "links": {
    "first": "https://api.phare.io/{resource}?page=2",
    "last": "https://api.phare.io/{resource}?page=10",
    "prev": "https://api.phare.io/{resource}?page=1",
    "next": "https://api.phare.io/{resource}?page=1"
  }
}

Changes

  • 1df2702900a5Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

  • b6c9a3f98257Revision changes
    • breaking

      added subschema #2: Group component to the /// response property oneOf list for the response status

    • info

      added the new optional query request parameter tag

    • info

      added the non-success response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response property // became required for the status

    • info

      the response's property default value 1 was added for the status

    • info

      the response's property default value all was added for the status

    • info

      the response's property default value true was added for the status