Export monitors

Exports details for selected monitors.

POST https://app.upfour.io/v1/monitors/export-details

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

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs monitor.read.

Body

JSONEdit the request body sent to this endpoint.

Headers

Idempotency-KeyheaderGenerated automatically when empty. How it works

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 monitor.read stable Idempotency-Key supported returns 200

Body

application/json required 1 field

All other fields1 fields

monitor_idsuuid[]

Returns

A successful request returns 200 with application/json.

Response fields 2 top-level fields

Field Type Description

data MonitorExportDetails[] · nullable

Each item · 6 fields

Field Type Description

channels MonitorExportChannel[] · nullable

Each item · 3 fields

Field	Type	Description
`id`	uuid
`name`	string
`type`	string

metadata map of string · nullable max 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.

monitor_id uuid

pagination Pagination

Pagination · 5 fields

Field	Type	Description
`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.

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

curl -s -X POST "https://app.upfour.io/v1/monitors/export-details" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "monitor_ids": [ "00000000-0000-4000-8000-000000000001" ] }'

const res = await fetch("https://app.upfour.io/v1/monitors/export-details", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ monitor_ids: ["00000000-0000-4000-8000-000000000001"], }), }); console.log(res.status, await res.json());

import os import requests res = requests.post( "https://app.upfour.io/v1/monitors/export-details", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "monitor_ids": ["00000000-0000-4000-8000-000000000001"], }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "monitor_ids": [ "00000000-0000-4000-8000-000000000001" ] }`) req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/monitors/export-details", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $payload = <<<'JSON' { "monitor_ids": [ "00000000-0000-4000-8000-000000000001" ] } JSON; $ch = curl_init("https://app.upfour.io/v1/monitors/export-details"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": [ { "channels": [], "metadata": {}, "monitor_id": "00000000-0000-4000-8000-000000000001" } ], "pagination": { "cursor": null, "has_more": false, "limit": 50, "next_cursor": null, "prev_cursor": null } }