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

Update status page

Update an existing status page. Send only the parameters you wish to change (e.g. company_url)

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

URL parameters

status_page_id
string

The ID of the status page you want to update

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
string

application/json

Body parameters

history
integer

Number of days of history to display on the status page. Between 7 and 365.

company_name
string

Name of your company, displayed on the status page.

company_url
string

URL of your company's website

contact_url
string

URL visitors can use to contact you in an emergency, for example https://example.com/support or mailto:support@example.com. Can be null.

logo_url
string

A direct link to your company's logo, including the https:// scheme. We download the image from it, and it must be under 20MB in size.

dark_logo_url
string

A direct link to a dark version of your company's logo, including the https:// scheme. We download the image from it, and it must be under 20MB in size.

whitelabeled
boolean

Whether to remove the 'Powered by Better Stack' footer. This is a billable feature

timezone
string

Timezone to display your status page in, for example Tokyo or Europe/Prague. Accepts IANA time zone IDs and the names in the Rails TimeZone documentation

subdomain
string

Subdomain of your status page. It must be unique across Better Stack, up to 63 characters of letters, digits, dashes and underscores.

custom_domain
string

A host name you own to serve the status page from, for example status.walmine.com. Add a CNAME record pointing it to statuspage.betteruptime.com. Can be null.

min_incident_length
integer

Hide incidents shorter than this many seconds from the status page. 0 shows all incidents. Must be shorter than one year.

subscribable
boolean

Whether visitors can subscribe to updates of your status page.

hide_from_search_engines
boolean

Whether to hide your status page from search engines.

custom_css
string

Unleash your inner designer and tweak our status page design to fit your branding

custom_javascript
string

Level up your status page by adding analytics, interactive features, or any other functionality you need

design
string

Classic or modern status page design. Possible values: v1, v2.

navigation_links
array of objects

Adjust the navigation links on your status page. Accepts an array of objects containing keys text and href:

• text is the navigation link label.

• href is the link. Use a full URL for external links. Use /, /maintenance and /incidents for built-in links.

At most 4 links are allowed. This only applies when the design is set to v2.

theme
string

Color theme of your status page. Possible values: light, dark, system. This only applies when the design is set to v2.

layout
string

Header layout of your status page. Possible values: vertical, horizontal. This only applies when the design is set to v2.

google_analytics_id
string

Your own Google Analytics ID to track visits to your status page, for example G-XXXXXXXX. Must start with G-, UA- or GTM-.

announcement
string

An announcement to show on your status page. Can be null.

announcement_embed_visible
boolean

Whether to show the announcement in the announcement embed. Embed it on your website with <script src="https://uptime.betterstack.com/widgets/announcement.js" data-id="YOUR_STATUS_PAGE_ID" async="async" type="text/javascript"></script>.

announcement_embed_link
string

URL the announcement embed links to. Defaults to your status page.

announcement_embed_css
string

Custom CSS for the announcement embed.

automatic_reports
boolean

Whether to automatically create status page updates for new incidents.

published
boolean

Whether the status page is published and accessible.

password_enabled
boolean

Whether to protect your status page with a password.

password
string

Password for your status page, stored encrypted. Required when password_enabled is true. Sending a password turns protection on unless you also send password_enabled, and sending an empty password turns it off.

require_sso
boolean

Require SSO sign-in to access your status page. Requires SSO to be configured for your organization and is mutually exclusive with password protection.

ip_allowlist
array of strings

Restrict access to your status page by IP address. Only visitors from specified IP addresses or CIDR ranges can view the status page. Entries starting with # are comments. This is a billable feature

status_page_group_id
integer

The ID of the status page group to which this status page will belong. Can be null.

200

Response body

{
  "data": {
    "id": "123456789",
    "type": "status_page",
    "attributes": {
      "company_name": "Best company - Tokyo branch",
      "company_url": "https://best-company.com",
      "contact_url": null,
      "logo_url": null,
      "dark_logo_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": null,
      "announcement_embed_link": null,
      "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",
      "created_at": "2020-08-10T07:34:38.848Z",
      "updated_at": "2020-12-08T14:12:31.680Z"
    }
  }
}
422

Response body

{
  "errors": "Sorry, you misspelled some attributes",
  "invalid_attributes": [
    "company_urlll"
  ]
}

Example cURL

Change company name Set up IP allowlisting 
curl --request PATCH \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456789 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "company_name": "Best company: Tokyo"
}'
curl --request PATCH \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456789 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "ip_allowlist": [
      "# Tokyo Office",
      "192.168.1.0/24",
      "# Production servers",
      "172.16.0.0/16"
    ]
}'


Previous article

Create status page

Next article

Remove status page