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

Update status page resource

Update an existing status page resource. Send only the parameters you wish to change (e.g. public_name), and note that resource_id and resource_type should be sent together.

PATCH https://uptime.betterstack.com/api/v2/status-pages/{status_page_id}/resources/{resource_id}

URL parameters

status_page_id
required string

The ID of your status page

resource_id
required string

The resource you want to update

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

status_page_section_id
integer

The ID of the section which should contain this resource. When omitted, defaults to the first section on the status page.

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.

This takes preference over history when both parameters are present.

resource_id
string

The ID of the resource you are adding

resource_type
string

The type of the resource you are adding. 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.

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. Defaults to any_incident.

mark_as_down_metadata_rule
object

A rule to match incident metadata. Required 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. Defaults to no_incident.

mark_as_degraded_metadata_rule
object

A rule to match incident metadata. Required 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.

fixed_position
boolean

If set to true, position reorders will be prevented.

200

Response body

{
  "data": {
    "id": "12345",
    "type": "status_page_resource",
    "attributes": {
      "status_page_section_id": 456789,
      "resource_id": 112233,
      "resource_type": "Monitor",
      "history": true,
      "widget_type": "history",
      "public_name": "https://uptime.betterstack.com/",
      "explanation": "",
      "position": 0,
      "mark_as_down_for": "incident_matching_metadata",
      "mark_as_down_metadata_rule": {
        "key": "Default escalation policy",
        "values": [
          {
            "type": "Policy",
            "item_id": "102683",
            "name": "Primary policy"
          }
        ]
      },
      "mark_as_degraded_for": "any_incident",
      "availability": 0.99963,
      "status": "operational",
      "status_history": [
        {
          "day": "2022-01-01",
          "status": "operational",
          "downtime_duration": 0,
          "maintenance_duration": 0
        },
        {
          "day": "2022-01-02",
          "status": "downtime",
          "downtime_duration": 120.0,
          "maintenance_duration": 0
        }
      ]
    }
  }
}

Example cURL

Example Metadata rules Metadata using email 
curl --request PATCH \
  --url https://uptime.betterstack.com/api/v2/status-pages/123456789/resources/12345 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  	"public_name": "My great monitor, updated"
  }'
curl --request PATCH \
  --url https://uptime.betterstack.com/api/v2/status-pages/123456789/resources/12345 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  	"mark_as_down_for": "incident_matching_metadata",
  	"mark_as_down_metadata_rule": {
      "key": "Severity",
      "values": [{ "value": "high" }]
    }
  	"mark_as_degraded_for": "all_incidents",
  }'
curl --request PATCH \
  --url https://uptime.betterstack.com/api/v2/status-pages/123456789/resources/12345 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  	"mark_as_down_for": "incident_matching_metadata",
  	"mark_as_down_metadata_rule": {
      "key": "Responsible team member",
      "values": [{ "email": 12345, "type": "User" }]
    }
  }'


Previous article

Create status page resource

Next article

Remove status page resource