Docs

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

Sign in Start free

Get client portal settings

Returns a Client's portal preset, incident visibility, report visibility and export setting.

GET https://app.upfour.io/v1/clients/{clientID}/portal-settings
GET https://app.upfour.io/v1/clients/{clientID}/portal-settings
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs client.read.
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 client.read stable returns 200

Parameters

FieldTypeDescription
clientID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data ClientPortalSettingsResponse
ClientPortalSettingsResponse · 10 fields
FieldTypeDescription
allow_report_export boolean
client_id uuid Taken from the path on update.
preset string one ofcompacttransparentcustom compact and transparent set all switches themselves and ignore the ones sent; custom takes them as sent. Empty means compact.
show_incidents boolean
show_report_downtime boolean
show_report_incidents boolean
show_report_response_time boolean
show_report_sla boolean
show_reports boolean The report views. With preset custom and this off, the report switches below are stored off.
updated_at string (date-time) Ignored on update.

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.