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. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Slack Integrations
    11. Splunk On-Call integrations
    12. PagerDuty Integrations
  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
      1. List all existing metadata GET
      2. Get a single metadata record GET
      3. Create a new metadata record POST
      4. Update an existing metadata record PATCH
      5. Delete an existing metadata record DELETE
      6. Metadata API response params

Metadata API response params

Response parameters

Namespace data

Parameter Type Values
id String ID of the metadata record.
type String metadata
attributes Object Attributes object. See below.
attributes.key String Key of the key-value pair.
attributes.value String Value of the key-value pair.
attributes.team_name String The team this metadata belongs to.
attributes.owner_id String ID of the owner.
attributes.owner_type String Type of the owner, possible values are Monitor, Heartbeat, Incident, WebhookIntegration, or EmailIntegration.

Previous article

Delete an existing metadata record