Leafcloud Status

Leafcloud Status - API

The 'Leafcloud Status' status page API is a RESTful API and provides programmatic access to entities on the page and lets you easily integrate the status page with 3rd party tools. Endpoints are displayed with examples using cURL.

Content

1. Summary

2. Status

3. Ping

4. Badges

Summary

Get a summary of the status page, including a page status, timezone, title, description, visibility, incidents and services.

Request

curl -X GET https://status.leaf.cloud/api/summary

Response

{
  "name": "Status Page",
  "domain": "status.leaf.cloud",
  "logoUrl": "https://my-page.com/logo.png",
  "visibility": "PUBLIC",
  "pageTitle": "Super Page Title",
  "pageDescription": "About my status page",
  "status": "MAJOR_OUTAGE",
  "services": [
    {
      "id": 5,
      "name": "My API Service",
      "status": "PARTIAL_OUTAGE",
      "showUptimeHistory": true,
      "uptime": {
        "rangeStart": "2021-12-09T11:40:00Z",
        "rangeEnd": "2022-03-09T11:40:00Z",
        "uptimePercentage": {
          "p90": 98.8,
          "p60": 98.8,
          "p30": 98.8
        },
        "outages": [
          {
            "status": "MAJOR_OUTAGE",
            "from": "2021-12-17T12:07:04Z",
            "until": "2021-12-17T12:23:05Z"
          },
          {
            "status": "PARTIAL_OUTAGE",
            "from": "2022-02-22T20:34:12Z",
            "until": "2022-03-09T11:40:00Z",
            "ongoing": true
          }
        ]
      }
    }
  ],
  "incidents": [
    {
      "id": 14501,
      "summary": "My API Service is down",
      "status": "IDENTIFIED",
      "message": "We have identified the root cause for this incident and are fixing it.",
      "createdAt": "2022-02-22T20:34:12Z",
      "updatedAt": "2022-02-22T20:34:12Z",
      "affectedServices": [
        {
          "impact": "PARTIAL_OUTAGE",
          "service": {
            "id": 5,
            "name": "My API Service"
          }
        }
      ]
    }
  ],
  "maintenanceWindows": [
    {
      "id": 30102,
      "description": "We need to upgrade our server software",
      "end": "2022-02-20T23:13:42Z",
      "services": [
        {
          "id": 5,
          "name": "My API Service"
        }
      ],
      "start": "2022-02-20T20:34:12Z",
      "summary": "Server Upgrade",
      "timezone": "Europe/Berlin"
    }
  ],
  "timezone": "Europe/Berlin"
}

Page status definition

•

OPERATIONAL:

All services operational

•

UNDER_MAINTENANCE:

Some services are under maintenance

•

DEGRADED:

Some services are degraded

•

PARTIAL_OUTAGE:

Some services are experiencing a partial outage

•

MAJOR_OUTAGE:

Some services are experiencing a major outage

Status

Get the status of the page, including a page status, timezone, title, description and visibility.

Request

curl -X GET https://status.leaf.cloud/api/status

Response

{
  "name": "My Status Page",
  "domain": "status.leaf.cloud",
  "logoUrl": "https://my-page.com/logo.png",
  "visibility": "PUBLIC",
  "pageTitle": "Super Page Title",
  "pageDescription": "About my status page",
  "status": "MAJOR_OUTAGE",
  "timezone": "Europe/Berlin"
}

Ping

Get the health of the page.

Request

curl -X GET https://status.leaf.cloud/ping

Response codes

•

200:

Status operational

•

404:

Status page not found

•

503:

Status not operational

Badges

Badges are visual representations of your status page. You can add badges to READMEs, documentation, or any other web page.

Html

<img src="https://status.leaf.cloud/badges/status.svg" alt="Leafcloud Status - Status" />

Markdown

[![Leafcloud Status - Status](https://status.leaf.cloud/badges/status.svg)](https://status.leaf.cloud)

Result