Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
    3. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Uptime API
    1. Getting 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 attributes
    7. Integrations
    8. Team members

Update metadata

Create, update, or remove metadata values for specified key for given incident, monitor, or other resources.

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

Resource to update metadata for

owner_type
required string

Type of resource to update metadata for. Accepted values: Monitor, Heartbeat, Incident, WebhookIntegration, EmailIntegration, IncomingWebhook, or CallRouting

key
required string

Metadata key

values
required array

Array of metadata values. Existing values for the given key will be replaced. See the list of metadata API parameters for details.

mode
string

How to apply the provided values. Accepted values: replace (default) replaces all existing values for the given key, merge adds the provided values to the existing ones.

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 Typed values Merge values Remove metadata 
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"
  }'
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": [
      { "type": "User", "item_id": "17" },
      { "type": "User", "email": "alice@betterstack.com" }
    ],
    "owner_id": "2",
    "owner_type": "Monitor"
  }'
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 3" }
    ],
    "mode": "merge",
    "owner_id": "2",
    "owner_type": "Monitor"
  }'
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": [],
    "owner_id": "2",
    "owner_type": "Monitor"
  }'


Previous article

List metadata

Next article

Response attributes