Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
    3. Escalation policies
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Slack Integrations
    11. Outgoing Webhook integrations
    12. Splunk On-Call integrations
    13. PagerDuty Integrations
  13. Status pages API
    1. Status pages
      1. List all existing status pages GET
      2. Get a single status page GET
      3. Create a new status page POST
      4. Update an existing status page PATCH
      5. Delete an existing status page DELETE
      6. Status pages API response params
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Create a new status page

Returns a newly created status page or validation errors.

POST https://betteruptime.com/api/v2/status-pages

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

history
integer

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

company_name
string

Name of your company

company_url
string

URL of your company's website

contact_url
string

URL that should be used for contacting you in case of an emergency

logo_url
string

A direct link to your company's logo. The image should be under 20MB in size

timezone
string

What timezone should we display your status page in? The accepted values can be found in the Rails TimeZone documentation. https://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html

subdomain
string

What subdomain should we use for your status page? This needs to be unique across our entire application, so choose carefully

custom_domain
string

Do you want a custom domain on your status page? Add a CNAME record that points your domain to status.betteruptime.com Example: CNAME status.walmine.com statuspage.betteruptime.com

min_incident_length
integer

If you don't want to display short incidents on your status page, this attribute is for you. In seconds.

subscribable
boolean

Do you want to allow users to subscribe to your status page changes?

hide_from_search_engines
boolean

Hide your status page from search engines

custom_css
string

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

design
string

Choose between classic and modern status page design. Possible values: v1, v2.

navigation_links
array of objects

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

• text is the navigation link label.

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

Only the first 4 links are considered. This only applies when the design is set to v2.

google_analytics_id
string

Specify your own Google Analytics ID if you want to receive hits on your status page

announcement
string

Add an announcement to your status page

announcement_embed_visible
boolean

Toggle this field if you want to show an announcement in your embed You can embed the announcement using this snippet: !SNIPPET MISSING (quotes in the snippet break markdown/toml syntax)!

announcement_embed_link
string

Point your embedded announcement to a specified URL

announcement_embed_custom_css
string

Modify the design of the announcement embed

password_enabled
boolean

Do you want to enable password protection on your status page?

password
string

Set a password of your status page (we won't store it as plaintext, promise) Required when passwordenabled: true We will set passwordenabled: false automatically when you send us an empty password

201

Response body

{
  "id": "123456789",
  "type": "status_page",
  "attributes": {
    "company_name": "Best company",
    "company_url": "https://best-company.com",
    "contact_url": null,
    "logo_url": null,
    "timezone": "Tokyo",
    "subdomain": "best-company-tokyo",
    "custom_domain": null,
    "custom_css": null,
    "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,
    "subscribable": false,
    "hide_from_search_engines": false,
    "password_enabled": false,
    "history": 90,
    "aggregate_state": "operational",
    "design": "v1",
    "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

Example
curl --request POST \
  --url https://betteruptime.com/api/v2/status-pages \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "company_url": "https://best-company.com",
    "company_name": "Best company",
    "subdomain": "best-company-tokyo",
    "timezone": "Tokyo"
}'

Previous article

Get a single status page

Next article

Update an existing status page