🔧
API
Status pages
Status pages help you communicate the system status of your services with customers and build confidence in your product.
Create a status page
To create a status page:
- Go to Integrations → Create status page
- Add your company name, subdomain, and a website URL
Configure a custom sub-domain status.yourdomain.com
A custom sub-domain allows you to display your status page on your own subdomain domain, such as status.example.com.
To host your status page on a custom sub-domain:
- Go to Status Pages
- Pick a status page you want to add a custom domain to
- Type your domain in the Custom domain field
- Add CNAME DNS record with generated Host and Target listed in the table
- Click Save changes
Configure the "Get in touch" button
Get in touch button allows your status page visitors to contact you.
To add a Get in touch button:
- Go to Status pages
- Pick a status page
- Type your website contact page URL or
mailto:address in the Get in touch URL field - Click Save changes
Configure displayed monitor names
Replace the URLs displayed on your status page with formatted monitor names. These are different from the pronounceable monitor names you use internally.
To edit the monitor names on your status page:
- Go to Status pages
- Select a status page
- Scroll down to Monitors & Heartbeats
- Click ＞ on the draggable monitor card in the Selected column
- Edit the Public name
- Click Save changes
Mark a service as degraded
To mark a service as degraded on your status page:
- Go to Status pages
- Select a status page and head to the Reports tab
- Click Create report
- Add a description and mark which services are affected
- Click Create report to save the changes
Resolve the degradation and add comments to update your users on the progress.
- Open the status page report
- Click Create status update
- Add the update message and select the affected services
- Click Create update
- You can add multiple updates as well as edit existing ones
Add a maintenance report
Schedule a maintenance announcement affecting your services.
To announce ongoing or upcoming maintenance on your status page:
- Go to Status pages
- Open a status page and head to the Maintenance tab
- Click Schedule maintenance
- Add a description, the time frame, and select the services that will be affected
- Click Schedule maintenance to post the announcement
Last modified 7d ago