List catalog relations

Returns a list of all your Catalog relations.

GET https://incidents.betterstack.com/api/v2/catalog/relations

Query parameters

page

integer

The page number to return, starting with 1.

per_page

integer

Number of results per page. Defaults to 50, maximum 250.

Headers

Authorization

required string

Bearer $TOKEN

200

Returns a list of existing Catalog relations.

Response body

{
  "data": [
    {
      "id": "37",
      "type": "catalog_relation",
      "attributes": {
        "name": "Team",
        "description": "Catalog of organization teams",
        "match_mode": "any"
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/catalog/relations?page=1",
    "last": "https://incidents.betterstack.com/api/v2/catalog/relations?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

string

The ID of the Catalog relation.

type

string

Always catalog_relation.

attributes.name

string

The name of the Catalog relation.

attributes.description

string or null

The description of the Catalog relation, or null when it has none.

attributes.match_mode

string

How the relation matches incidents: any applies a record as soon as one of its primary attribute values matches the incident's metadata, all only when every primary attribute value matches, with an empty value matching anything.

pagination.first

string

The URL of the first page. Read more about pagination.

pagination.last

string

The URL of the last page.

pagination.prev

string or null

The URL of the previous page, or null on the first page.

pagination.next

string or null

The URL of the next page, or null on the last page.

Example cURL

Example

Copied!

curl --request GET \
  --url https://incidents.betterstack.com/api/v2/catalog/relations \
  --header "Authorization: Bearer $TOKEN"

Remove PagerDuty integration

Get catalog relation

Explore documentation

List catalog relations

Example cURL

Please accept cookies