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
    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

Update an existing 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 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.

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, Heartbeat, WebhookIntegration, EmailIntegration

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.

200

Response body

{
  "id": "12345",
  "type": "resource",
  "attributes": {
    "resource_id": 112233,
    "resource_type": "Monitor",
    "public_name": "My great monitor, updated",
    "explanation": "Hide easter eggs here",
    "history": false,
    "widget_type": "plain",
    "position": 0,
    "availability": 1.0,
    "status": "operational",
    "status_history": [
      {
        "day": "2022-01-01",
        "status": "operational",
        "downtime_duration": 0
      }
    ]
  }
}

Example cURL

Example
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"
}'

Previous article

Create a new status page resource

Next article

Delete an existing status page resource