Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
      1. Status pages API
        1. List status pages GET
        2. Get status page GET
        3. List status pages in group GET
        4. Create status page POST
        5. Update status page PATCH
        6. Remove status page DELETE
      2. Status page groups
      3. Status page sections
      4. Status page resources
      5. Status page subscribers
      6. Status page reports
      7. Status page report updates
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Get status page

Returns a single status page by ID.

GET https://incidents.betterstack.com/api/v2/status-pages/{status_page_id}

URL parameters

status_page_id
required string

The ID of the status page you want to get

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single status page.

Response body

{
  "data": {
    "id": "123456789",
    "type": "status_page",
    "attributes": {
      "company_name": "Best company",
      "company_url": "https://best-company.com",
      "contact_url": null,
      "logo_url": null,
      "dark_logo_url": null,
      "logo_remote_url": null,
      "dark_logo_remote_url": null,
      "whitelabeled": false,
      "timezone": "Tokyo",
      "subdomain": "best-company-tokyo",
      "custom_domain": null,
      "custom_css": null,
      "custom_javascript": "",
      "google_analytics_id": null,
      "min_incident_length": 400,
      "announcement": null,
      "announcement_embed_visible": false,
      "announcement_embed_css": "",
      "announcement_embed_link": "",
      "automatic_reports": false,
      "published": true,
      "status_page_group_id": null,
      "subscribable": false,
      "hide_from_search_engines": false,
      "password_enabled": false,
      "require_sso": false,
      "ip_allowlist": [],
      "history": 90,
      "aggregate_state": "operational",
      "design": "v1",
      "navigation_links": [],
      "theme": "light",
      "layout": "vertical",
      "organization_id": 123456,
      "created_at": "2020-08-10T07:34:38.848Z",
      "updated_at": "2020-12-08T14:12:31.680Z"
    }
  }
}

Response attributes

id
string

The ID of the status page.

type
string

Always status_page.

attributes.company_name
string

Name of your company, displayed on the status page.

attributes.company_url
string or null

URL of your company's website.

attributes.contact_url
string or null

URL visitors can use to contact you in an emergency.

attributes.logo_url
string or null

URL your company's logo is served from, null when there is no logo.

attributes.dark_logo_url
string or null

URL the dark version of your logo is served from, null when there is none.

attributes.logo_remote_url
string or null

URL the logo was downloaded from when it was set through logo_url.

attributes.dark_logo_remote_url
string or null

URL the dark logo was downloaded from when it was set through dark_logo_url.

attributes.whitelabeled
boolean

Whether the 'Powered by Better Stack' footer is removed.

attributes.timezone
string

Timezone the status page is displayed in, as a Rails time zone name such as Tokyo.

attributes.subdomain
string

Subdomain of the status page.

attributes.custom_domain
string or null

Your own host name the status page is served from, null when not set.

attributes.custom_css
string or null

Custom CSS applied to the status page.

attributes.custom_javascript
string or null

Custom JavaScript added to the status page.

attributes.google_analytics_id
string or null

Google Analytics ID that tracks visits to the status page.

attributes.min_incident_length
integer

Incidents shorter than this many seconds are hidden from the status page. 0 shows all incidents.

attributes.announcement
string or null

Announcement shown on the status page.

attributes.announcement_embed_visible
boolean

Whether the announcement shows in the announcement embed.

attributes.announcement_embed_css
string or null

Custom CSS for the announcement embed.

attributes.announcement_embed_link
string or null

URL the announcement embed links to. When empty, it links to the status page.

attributes.automatic_reports
boolean

Whether status page updates are created automatically for new incidents.

attributes.published
boolean

Whether the status page is published and accessible.

attributes.status_page_group_id
integer or null

ID of the status page group the page belongs to, null when it's in none.

attributes.subscribable
boolean

Whether visitors can subscribe to updates of the status page.

attributes.hide_from_search_engines
boolean

Whether the status page is hidden from search engines.

attributes.password_enabled
boolean

Whether the status page is password protected.

attributes.require_sso
boolean

Whether visitors must sign in with SSO to see the status page.

attributes.ip_allowlist
array of strings

IP addresses and CIDR ranges allowed to view the status page, including comment entries starting with #. Empty when anyone can view it.

attributes.history
integer

Number of days of history displayed on the status page, between 7 and 365.

attributes.aggregate_state
string

Overall state of the page's resources: operational, degraded, downtime or maintenance.

attributes.design
string

Status page design: v1 for classic or v2 for modern.

attributes.navigation_links
array of objects

Navigation links shown on the status page with the v2 design.

attributes.navigation_links[].text
string

Label of the navigation link.

attributes.navigation_links[].href
string

Target of the navigation link: a full URL, or /, /maintenance or /incidents for built-in pages.

attributes.theme
string

Color theme with the v2 design: light, dark or system.

attributes.layout
string

Header layout with the v2 design: vertical or horizontal.

attributes.organization_id
integer

ID of the Better Stack organization the status page belongs to.

attributes.created_at
string

When the status page was created, in ISO 8601 format.

attributes.updated_at
string

When the status page was last updated, in ISO 8601 format.

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456789 \
  --header "Authorization: Bearer $TOKEN"


Previous article

List status pages

Next article

List status pages in a group