Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Replace resource metadata

Accepts a resource type, resource ID and key/value pairs.

PUT https://app.upfour.io/v1/metadata
PUT https://app.upfour.io/v1/metadata

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs metadata.write.
Body
resource_typerequired

1 more field is only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope metadata.write stable returns 200

Body

application/json required 3 fields

metadatamap of stringrequiredmax 100 keyseach value max length 4096

Custom key/value pairs (at most 100 keys; keys 1-128 characters, values up to 4096). Sent to machine-readable alert channels and API webhook subscriptions, and copied onto the incidents the resource opens.

resource_iduuidrequired
resource_typestringrequired
monitorheartbeatincidentclient

Returns

A successful request returns 200 with application/json.

Response fields 2 top-level fields
FieldTypeDescription
data ResourceMetadata[] · nullable
Each item · 8 fields
FieldTypeDescription
created_at string (date-time)
id uuid
key string
organization_id uuid
resource_id uuid
resource_type string one ofmonitorheartbeatincidentclient
updated_at string (date-time)
value string
pagination Pagination
Pagination · 5 fields
FieldTypeDescription
cursor string · nullable
has_more boolean
limit integer 1–250
next_cursor string · nullable
prev_cursor string · nullable

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.