List section resources

Returns section resources with their source, current status, display settings and positions.

GET https://app.upfour.io/v1/status-pages/{pageID}/sections/{sectionID}/resources

Authorization

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

Path

pageIDpath · requiredPart of the request path. sectionIDpath · requiredPart of the request path.

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 status_page.read stable returns 200

Parameters

Field	Type	Description
`pageID` required	uuid	path parameter
`sectionID` required	uuid	path parameter

Returns

A successful request returns 200 with application/json.

Response fields 2 top-level fields

Field Type Description

data StatusPageResource[] · nullable

Each item · 45 fields

Field Type Description

auto_publish boolean

explanation string

heartbeat_id uuid · nullable

id uuid

mark_degraded_for string any_incident shows an open incident as degraded instead of down; any non-empty value also shows a slow but up monitor as degraded. Default no_incident.

mark_down_for string any_incident (the default) shows the component as down while an incident is open; any other value shows it as degraded instead.

monitor_id uuid · nullable

position integer

public_name string

section_id uuid

widget_type string

active_incident_ids uuid[]

feed_component_id string

feed_component_name string

feed_format string one ofstatuspage_v2instatus

feed_url string

freshness_timeout_seconds integer

history PublicStatusHistory

PublicStatusHistory · 12 fields

Field Type Description

covered boolean

days integer

ends_at string (date-time)

segments PublicStatusHistoryDay[] · nullable

Each item · 4 fields

Field	Type	Description
`covered`	boolean
`date`	string
`status`	string one of`updegradeddownno_data`
`uptime_percentage`	number

starts_at string (date-time)

uptime_by_range map of number

uptime_percentage number

watching_since string (date-time)

is_external boolean

last_checked_at string (date-time)

manual_status string one ofoperationaldegradeddownmaintenance

monitor_state string one ofUPDOWNPAUSED

response_times PublicResponseTimeHistory

PublicResponseTimeHistory · 5 fields

Field Type Description

days PublicResponseTimeDay[] · nullable

Each item · 3 fields

Field	Type	Description
`avg_ms`	number
`date`	string
`p95_ms`	number

current_avg_ms number

runtime_status string Current status of the component, derived from its monitor, scheduled job, manual status or vendor feed.

source StatusPageResourceSource

StatusPageResourceSource · 3 fields

Field	Type	Description
`checked_at`	string (date-time) · nullable
`name`	string
`url`	string

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.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.

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

const res = await fetch("https://app.upfour.io/v1/status-pages/00000000-0000-4000-8000-000000000001/sections/00000000-0000-4000-8000-000000000002/resources", { headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, }, }); console.log(res.status, await res.json());

import os import requests res = requests.get( "https://app.upfour.io/v1/status-pages/00000000-0000-4000-8000-000000000001/sections/00000000-0000-4000-8000-000000000002/resources", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/status-pages/00000000-0000-4000-8000-000000000001/sections/00000000-0000-4000-8000-000000000002/resources", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) 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 $ch = curl_init("https://app.upfour.io/v1/status-pages/00000000-0000-4000-8000-000000000001/sections/00000000-0000-4000-8000-000000000002/resources"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": [ { "auto_publish": true, "explanation": "", "heartbeat_id": null, "id": "00000000-0000-4000-8000-000000000003", "mark_degraded_for": "", "mark_down_for": "", "monitor_id": "00000000-0000-4000-8000-000000000004", "position": 0, "public_name": "Marketing website", "section_id": "00000000-0000-4000-8000-000000000002", "widget_type": "" } ], "pagination": { "cursor": null, "has_more": false, "limit": 50, "next_cursor": null, "prev_cursor": null } }