Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. 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. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. Integrations
      1. New Relic
      2. Datadog
      3. AWS CloudWatch
      4. Amazon SNS
      5. Microsoft Azure
      6. Google Monitoring
      7. Grafana
      8. Elastic
      9. Prometheus
      10. E-mail
      11. Incoming webhooks
      12. Atlassian Jira
      13. Slack
      14. Outgoing webhooks
      15. Outgoing e‑mails
      16. Splunk On-Call
      17. PagerDuty
      18. Catalog
        1. Catalog relations
          1. List catalog relations GET
          2. Get catalog relation GET
          3. Create catalog relation POST
          4. Update catalog relation PATCH
          5. Remove catalog relation DELETE
        2. Catalog attributes
        3. Catalog records
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Update catalog relation

Update an existing Catalog relation.

PATCH https://incidents.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
required string

The name of the Catalog relation. Required on every update, even when it doesn't change.

description
string

A description of the Catalog relation.

match_mode
string

any applies a record when at least one of its primary attribute values matches the incident's metadata. all applies it only when every primary attribute value matches, with an empty value matching anything.

200

Returns the Catalog relation

Response body

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

Example cURL

Example
curl -X "PATCH" "https://incidents.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 catalog relation

Next article

Remove catalog relation