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. Update metadata POST
        3. Response params
    7. Integrations

List metadata

List metadata for given incident, monitor, or other resources. This endpoint supports pagination.

GET https://uptime.betterstack.com/api/v3/metadata

Query parameters

owner_id
string

Resource to return metadata for. Metadata for all resources will be returned if omitted.

owner_type
string

Type of resource to return metadata for. Accepted values: Monitor, Heartbeat, Incident, WebhookIntegration, EmailIntegration

team_name
string

Return only metadata for resources owned by a specified team. Works only when using a global API token.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns list of existing metadata

Response body

{
  "data": [
    {
      "id": "25",
      "type": "metadata",
      "attributes": {
        "key": "Key 1",
        "values": [{ "type": "String", "value": "Value 1" }, { "type": "String", "value": "Value 2" }]
        "team_name": "Testing",
        "owner_id": "2",
        "owner_type": "Monitor"
      }
    },
    {
      "id": "23",
      "type": "metadata",
      "attributes": {
        "key": "Key 2",
        "values": [{ "type": "Schedule", "item_id": 123, "name": "Secondary calendar" }],
        "team_name": "Testing",
        "owner_id": "30579",
        "owner_type": "WebhookIntegration"
      }
    }
  ],
  "pagination": {
    "first": "https://uptime.betterstack.com/api/v3/metadata?page=1",
    "last": "https://uptime.betterstack.com/api/v3/metadata?page=4",
    "prev": null,
    "next": "https://uptime.betterstack.com/api/v3/metadata?page=2"
  }
}

Example cURL

Example
curl --request GET \
  --url "https://uptime.betterstack.com/api/v3/metadata?owner_id=2&owner_type=Monitor" \
  --header 'authorization: Bearer $TOKEN'

Previous article

Response params

Next article

Update metadata