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. Elastic Integrations
    8. Prometheus Integrations
    9. Email integrations
    10. Incoming webhooks
    11. Jira integrations
    12. Slack Integrations
    13. Outgoing Webhook integrations
    14. Splunk On-Call integrations
    15. PagerDuty Integrations
    16. Catalog integration
      1. Catalog relations
        1. List all Catalog relations GET
        2. Get a single Catalog relation GET
        3. Create a Catalog relation POST
        4. Update a Catalog relation PATCH
        5. Delete a Catalog relation DELETE
        6. Catalog relation API response params
      2. Catalog attributes
      3. Catalog records
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Update a Catalog relation

Update an existing Catalog relation. Send only the parameters you wish to change (eg. name).

PATCH https://uptime.betterstack.com/api/v2/catalog/relations/{relation_id}

URL parameters

relation_id
required string

The ID of the Catalog relation you want to update

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

name
string

The name of the Catalog relation

*

Any params you'd like to set. See the list of all Catalog relation API parameters for details.

200

Returns the Catalog relation

Response body

{
  "data": {
    "id": "37",
    "type": "catalog_relation",
    "attributes": {
      "name": "Team",
      "description": "Catalog of organization teams"
    }
  }
}

Example cURL

Example
curl -X "PATCH" "https://uptime.betterstack.com/api/v2/catalog/relations/37" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "name": "Test Again"
}'

Previous article

Create a Catalog relation

Next article

Delete a Catalog relation