Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  5. Incidents
    1. Get started
    2. Advanced guide
  6. Status pages
    1. Get started
    2. Advanced guide
  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. Uptime API
    1. Get an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
      1. Metadata API
        1. List metadata GET
        2. Get metadata GET
        3. Create metadata POST
        4. Update metadata PATCH
        5. Remove metadata DELETE
        6. Response params
    7. Integrations

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.values.[] MetadataValue An array of metadata values. See the MetadataValue section below for attribute details.
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.

MetadataValue

Parameter Type Values
type String Type of the metadata value, possible values are String, User, Team, Policy, Schedule, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, or PagerDutyWebhook. If omitted during creating or updating, a String type is assumed.
value String String value of the metadata value object. Used only if type is String.
item_id String ID of the item referenced by the metadata value. Used with all types except String. A name or an email attribute (see below) can be used instead when creating or updating metadata values.
name String Name of the referenced item. Used with all types except String.
email String Email of the user referenced by the metadata value. Used with User type.

Previous article

Remove metadata

Next article

List New Relic integrations