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 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
    7. Integrations

Create a new metadata record

This will create a new metadata.

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

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

owner_id
required string

The ID of the owner

owner_type
required string

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

key
required string

Metadata key

values
required array

Array of metadata values. See the list of metadata API parameters for details.

201

The metadata was successfully created

Response body

{
  "data": {
    "id": "25",
    "type": "metadata",
    "attributes": {
      "key": "Key 1",
      "values": [{ "type": "String", "value": "Value 1" }, { "type": "String", "value": "Value 2" }]
      "owner_id": "2",
      "owner_type": "Monitor"
    }
  }
}
403

Authentication failed

Example cURL

Example
curl --request POST \
  --url https://uptime.betterstack.com/api/v3/metadata \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"key": "Key 1", "values": [{ value: "Value 1" }, { value: "Value 2" }], "owner_id": "2", "owner_type": "Monitor"}'

Previous article

Get a single metadata record

Next article

Update an existing metadata record