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

Catalog record API response params

Response body parameters

Namespace data

Parameter Type Value
id String The ID of the Catalog relation. String representation of a number.
type String catalog_relation
attributes Object Attributes object. Contains all the Catalog relation attributes. See below.
attributes.attributes Array Array of attributes for this Catalog record. See below.
attributes.attributes.0.attribute Object The attribute these values belong to. See below.
attributes.attributes.0.attribute.id String The ID of the attribute.
attributes.attributes.0.attribute.name String Name of the attribute.
attributes.attributes.0.values Array Array of values for this attribute. See below.
attributes.attributes.0.values.0.type String The type of the value. Valid options: String, User, Team, Policy, Schedule, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook
attributes.attributes.0.values.0.value String Value when type is String.
attributes.attributes.0.values.0.item_id String ID of the referenced item when type is different than String.
attributes.attributes.0.values.0.name String Human readable name of the referenced item when type is different than String and the item has a name.
attributes.attributes.0.values.0.email String Email of the referenced user when type is User.

Previous article

Batch delete Catalog records

Next article

List all existing status pages