Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
    3. 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. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
      1. Status pages API
      2. Status page groups
      3. Status page sections
      4. Status page resources
        1. List status page resources GET
        2. Get status page resource GET
        3. Create status page resource POST
        4. Update status page resource PATCH
        5. Remove status page resource DELETE
        6. Response attributes
      5. Status page reports
      6. Status page report updates
    6. Metadata
    7. Integrations

Response attributes

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

Parameter Type Values
status_page_section_id Integer ID of the section this status page resource resides in.
resource_id Integer ID of the resource on which is the status page resource pointing. E.g.: the ID of the monitor.
resource_type String Type of the resource on which is the status page resource pointing (e.g.: Monitor) Available values: Monitor, MonitorGroup, Heartbeat, HeartbeatGroup, WebhookIntegration, EmailIntegration, IncomingWebhook, ResourceGroup, LogsChart, CatalogReference.
public_name String The resource name displayed publicly on your status page.
explanation String A detailed text displayed as a help icon.
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.
widget_type String What widget to display for this resource. Expects one of four values:
plain - Only display status.
history - Display detailed historical status.
response_times - Add a response times chart. Only for Monitor or LogsChart.
chart_only - Shows just the chart. Only for LogsChart.
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.
mark_as_down_for String How the resource status is affected when an incident occurs. Possible values: any_incident, no_incident, incident_matching_metadata.
mark_as_down_metadata_rule Object A rule to match incident metadata. Only present when mark_as_down_for is incident_matching_metadata. The rule is a JSON object with key and values fields. See the metadata API response params for details about metadata value attributes.
mark_as_degraded_for String How the resource status is affected when an incident occurs. Possible values: any_incident, no_incident, incident_matching_metadata.
mark_as_degraded_metadata_rule Object A rule to match incident metadata. Only present when mark_as_degraded_for is incident_matching_metadata. The rule is a JSON object with key and values fields. See the metadata API response params for details about metadata value attributes.
availability Double (Decimal number) Takes on a the percentage value of a resource's availability.
status String The current status of the resource. Can be one of not_monitored (when the underlying monitor is paused), operational, maintenance, degraded, or downtime.
status_history.[] StatusHistory Array of history objects. See the StatusHistory section below for attribute details.

StatusHistory

Parameter Type Values
day String Single day. In YYYY-MM-DD format.
status String Status during this day.
downtime_duration Integer The duration of downtime in seconds.
maintenance_duration Integer The duration of maintenance in seconds.

Previous article

Remove status page resource

Next article

List status page reports