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. Severities
    4. Incidents
    5. 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. Splunk On-Call integrations
    11. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
      1. List existing resources of a status page GET
      2. Get a single status page resource GET
      3. Create a new status page resource POST
      4. Update an existing status page resource PATCH
      5. Delete an existing status page resource DELETE
      6. Status page resources API response params
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Status page resources API response params

Response parameters

Namespace data

Parameter Type Values
id String ID of the status page resource
type String status_page_resource
attributes Object Attributes object (see below)
attributes.resource_id Integer ID of the resource on which is the status page resource pointing (e.g.: the ID of the monitor)
attributes.resource_type String Type of the resource on which is the status page resource pointing (e.g.: Monitor) Available values: Monitor, Heartbeat, WebhookIntegration, EmailIntegration
attributes.public_name String The resource name displayed publicly on your status page.
attributes.explanation String A detailed text displayed as a help icon.
attributes.history (deprecated) Boolean DEPRECATED Do you want to show the incident history for this item? Default: true Please use the widget_type for this setting
attributes.widget_type String What widget to display for this resource. Expects one of three values: plain - only display status history - display detailed historical status response_times - add a response times chart (only for Monitor . This takes preference over history when both parameters are present.
attributes.position Integer The position of this resource on your status page, indexed from zero. If you don't specify a position, we add the resource to the end of the status page. When you specify a position of an existing resource, we add the resource to this position and shift resources below to accommodate.
attributes.availability Double (Decimal number) Takes on a the percentage value of a resource's availability
attributes.status_history Array of objects Array of history objects (see below)
attributes.status_history[index].day String (Date in YYYY-MM-DD format) Single day.
attributes.status_history[index].status String Status during this day.
attributes.status_history[index].downtime_duration Integer

Previous article

Delete an existing status page resource

Next article

List existing reports on a status page