Skip to content
GitHub

A project's public status page. No sign-in; nothing internal.

GET
/api/v1/public/status/{slug}
curl --request GET \
  --url https://example.com/api/v1/public/status/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

The page’s public name

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
title
required
string
status
required

operational, degraded or majorOutage.

string
components
required
Array<object>
object
name
required
string
status
required
string
incidents
required
Array<object>
object
component
required

The affected component.

string
severity
required

critical, warning or info.

string
startedAt
required
string
resolvedAt
string | null
updatedAt
required
string
Examplegenerated
{
  "title": "example",
  "status": "example",
  "components": [
    {
      "name": "example",
      "status": "example"
    }
  ],
  "incidents": [
    {
      "component": "example",
      "severity": "example",
      "startedAt": "example",
      "resolvedAt": "example"
    }
  ],
  "updatedAt": "example"
}

404

Section titled “404”
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
  "code": "forbidden"
}