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
      2. Catalog attributes
      3. Catalog records
        1. List all Catalog records GET
        2. Get a single Catalog record GET
        3. Create a Catalog record POST
        4. Update a Catalog record PATCH
        5. Delete a Catalog record DELETE
        6. Batch create Catalog records POST
        7. Batch update Catalog records PUT
        8. Batch delete Catalog records DELETE
        9. Catalog record API response params
  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

Create a Catalog record

Returns either a newly created Catalog record, or validation errors.

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

URL parameters

relation_id
required string

The ID of the Catalog relation you want to create a record for.

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

attributes
required array

Attributes for the Catalog record.

Each item in the array describes the values for a single attribute defined on the related Catalog relation. Every item has two fields: attribute and values.

attributes.0.attribute
required object

Object describing the target attribute. Either id or name must be provided for matching the Catalog attribute.

attributes.0.attribute.id
string

ID of the target Catalog attribute.

attributes.0.attribute.name
string

Name of the target Catalog attribute.

attributes.0.values
required array

Array of objects where each object describes a single value for the target attribute (Attributes can have multiple values).

Value types can be grouped into main categories:
- Scalar: String
- Reference: User, Team, Policy, Schedule, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook

The value of a Scalar type is defined using the value field.

The value of a Reference type is defined using one of the following fields:
- item_id - great choice when you know the ID of the target item.
- email - your go to choice when you're referencing users.
- name - can be used to reference other items like teams, policies, etc.

The reference types require the presence of at least one of the three fields: item_id, name, email.

attributes.0.values.0.type
required string

Type of the value. Valid options: String, User, Team, Policy, Schedule, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook

attributes.0.values.0.value
string

Value when type is String. Required when type is String.

attributes.0.values.0.item_id
string

ID of the referenced item when type is different than String.

attributes.0.values.0.name
string

Name of the referenced item when type is different than String.

attributes.0.values.0.email
string

Email of the referenced user when type is User.

201

Returns newly created Catalog record

Response body

{
  "data": {
    "id": "67",
    "type": "catalog_record",
    "attributes": {
      "attributes": [
        {
          "attribute": {
            "id": "56",
            "name": "Team"
          },
          "values": [
            {
              "type": "String",
              "value": "My Team"
            }
          ]
        },
        {
          "attribute": {
            "id": "57",
            "name": "Team Lead"
          },
          "values": [
            {
              "type": "Team",
              "item_id": "123"
            }
          ]
        }
      ]
    }
  }
}

Example cURL

Example
curl -X "POST" "https://uptime.betterstack.com/api/v2/catalog/relations/67/records" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "attributes": [
    {
      "attribute": { "id": "56", "name": "Team" },
      "values": [
        { "type": "String", "value": "My Team" }
      ]
    },
    {
      "attribute": { "id": "57", "name": "Team Lead" },
      "values": [
        { "type": "Team", "item_id": "123" }
      ]
    }
  ]
}'

Previous article

Get a single Catalog record

Next article

Update a Catalog record