Docs

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

Sign in Start free

Get the health advisor report

Returns findings, severity counts and the evaluated scope.

GET https://app.upfour.io/v1/advisor
GET https://app.upfour.io/v1/advisor
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs report.read.
Query

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

Parameters

FieldTypeDescription
limit optional integer 1–250default 50 query parameter
cursor optional string query parameter
client_id optional uuid query parameter
all_clients optional boolean query parameter
q optional string query parameter
sort optional string query parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data AdvisorReport
AdvisorReport · 19 fields
FieldTypeDescription
critical_count integer
findings AdvisorFinding[] · nullable
Each item · 12 fields
FieldTypeDescription
rule_id string Identifier of the rule, e.g. monitor_without_recipient, interval_below_plan_minimum, ssl_expiring_soon, single_region. New rules can appear.
severity string one ofcriticalwarninghint
target_type string one ofmonitorchannelescalation_policyheartbeatorganization
title string
why string
fix_action string attach_default_channel or set_interval when POST /advisor/apply can fix the finding; absent for advice that only links to fix_href.
fix_href string
fix_label string
message_params object free-form keys Values for localizing the finding's prose; the keys depend on the rule.
message_variant string
target_id uuid
target_name string
generated_at string (date-time)
hint_count integer
monitors_with_findings map of string · nullable one ofcriticalwarninghint Highest severity per monitor ID with findings.
scope string one oforganizationmonitor
warning_count integer

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.