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
  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. Escalation policies
    3. Severities
    4. Incidents
    5. 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. Splunk On-Call integrations
    11. 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

Create a new metadata record

This will create a new metadata.

POST https://uptime.betterstack.com/api/v2/metadata

Headers

Authorization
required string

Bearer $TEAM_TOKEN

Content_Type
string

application/json

Body parameters

owner_id
string

The ID of the owner

owner_type
string

The type of the owner record - accepted values are(Monitor, Heartbeat, Incident, WebhookIntegration, and EmailIntegration)

key
string

Metadata key

value
string

Metadata value (optional)

201

The metadata was successfully created

Response body

{
  "data": {
    "id": "25",
    "type": "metadata",
    "attributes": {
      "key": "KEY_1",
      "value": "value-1"
    },
    "relationships": {
      "owner": {
        "data": {
          "id": "2",
          "type": "Monitor"
        }
      }
    }
  }
}
403

Authentication failed

Example cURL

Example
curl --request POST \
  --url https://uptime.betterstack.com/api/v2/metadata \
  --header "Authorization: Bearer $TEAM_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"key": "KEY_1", "value": "value-1", "owner_id": "2", "owner_type": "Monitor"}'

Previous article

Get a single metadata record

Next article

Update an existing metadata record