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
  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. Escalation policies
    3. Escalation policy groups
    4. Severities
    5. Severity groups
    6. Incidents
    7. 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. Splunk On-Call integrations
    12. 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

Status pages API response params

Response parameters

Namespace data

Parameter Type Values
id String The ID of the status page.
type String status_page
attributes Object Attributes object. See below.
attributes.company_name String Name of your company. This will be displayed on the page.
attributes.company_url String URL of your company's website.
attributes.contact_url String URL that should be used for contacting you in case of an emergency. Can be null.
attributes.logo_url String A direct link to your company's logo. The image should be under 20MB in size.
attributes.timezone String Timezone to display your status page in. The accepted values can be found in the Rails TimeZone documentation.
attributes.subdomain String Subdomain to be used for your status page. This needs to be unique across our entire application, so choose carefully.
attributes.custom_domain String Optionally, you can set a host name you own. Example: status.walmine.com. Requires a CNAME record that points your domain to status.betteruptime.com. Example: CNAME status.walmine.com statuspage.betteruptime.com.
attributes.custom_css String Unleash your inner designer and tweak our status page design to fit your branding.
attributes.google_analytics_id String Specify your own Google Analytics ID if you want to receive hits on your status page.
attributes.min_incident_length Integer If you don't want to display short incidents on your status page, this attribute is for you. In seconds.
attributes.announcement String Add an announcement to your status page.
attributes.announcement_embed_enabled Boolean Toggle this field if you want to show an announcement in your embed You can embed the announcement using this snippet: <script src="https://betteruptime.com/widgets/announcement.js" data-id="<SET STATUS_PAGE_ID>" async="async" type="text/javascript"></script>.
attributes.announcement_embed_css String Modify the design of the announcement embed.
attributes.announcement_embed_link String Point your embedded announcement to a specified URL.
attributes.subscribable Boolean Whether to allow users to subscribe to your status page changes.
attributes.hide_from_search_engines Boolean Hide your status page from search engines.
attributes.password_enabled Boolean Whether to enable password protection on your status page.
attributes.history Integer Number of days to display on the status page. Between 7 and 365 days.
attributes.aggregate_state String Overall state of the resources on the status page. The possible values are: Operational Downtime Degraded.
attributes.created_at String (ISO DateTime) When was the status page created.
attributes.updated_at String (ISO DateTime) When was the status page last updated.

Previous article

Delete an existing status page

Next article

List existing sections of a status page