Docs

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

Sign in Start free

Upload a status page asset

Uploads a status-page asset for the selected kind and returns the updated page.

PUT https://app.upfour.io/v1/status-pages/{pageID}/assets/{kind}
PUT https://app.upfour.io/v1/status-pages/{pageID}/assets/{kind}

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

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs status_page.write.
Path

This call takes multipart/form-data. The console sends JSON only; use the curl example.

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

Parameters

FieldTypeDescription
pageID required uuid path parameter
kind required string one oflogologo_darkfavicon path parameter

Body

multipart/form-data required

filefilerequired

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data StatusPage
StatusPage · 61 fields
FieldTypeDescription
accent_color string
announcement string
appearance StatusPageAppearanceResponse · nullable null until a layout was chosen; the page then renders the default design (essential layout, paper ground).
StatusPageAppearanceResponse · 5 fields
FieldTypeDescription
ground string one ofpaperwhitecool Empty is stored as paper.
header_dark string #RRGGBB or empty for the platform default.
header_light string #RRGGBB or empty for the platform default.
layout string one ofessentialbrandoverview
version integer Must be 1.
automatic_reports boolean
automatic_reports_notify boolean
company_name string
company_url string
contact_url string
created_at string (date-time)
custom_css string
custom_domain string
custom_domain_certificate_status string one ofnonependingissuedfailedunknown
custom_domain_status string one ofnonepending_dnsqueuedprovisioningactivefaileddisabledconflict_requires_review
custom_js string Not supported: always empty.
default_language string · nullable Language of the page's own communication; null inherits from the client, then the company default.
design string No effect since Plan 82; accepted and stored only.
google_tag_id string Not supported: always empty.
header_layout string No effect since Plan 82; accepted and stored only.
hide_from_search_engines boolean
history_days integer
id uuid
is_published boolean
logo_url string
minimum_incident_length integer
organization_id uuid
password_protected boolean
remove_branding boolean
show_not_monitored_as_green boolean
subdomain string
subscribable boolean
theme string
timezone string
updated_at string (date-time)
uptime_decimals integer
access_restricted boolean Whether any visitor gate (password, e-mail codes, IP allowlist or access token) is on. Only in GET /status-pages.
auto_report_open_template_id uuid
auto_report_resolve_template_id uuid
client_id uuid
custom_domain_attempts integer
custom_domain_cleanup_requested_at string (date-time)
custom_domain_dns_target string
custom_domain_error string
custom_domain_last_checked_at string (date-time)
custom_domain_next_retry_at string (date-time)
custom_domain_pending_expires_at string (date-time)
custom_domain_ploi_tenant string
custom_domain_provisioned_at string (date-time)
custom_domain_verification_token string Value of the up4-status-verification TXT record that proves ownership of the domain.
custom_domain_verified_at string (date-time)
favicon_url string
logo_asset_url string
logo_dark_asset_url string
platform_url string
public_url string Where the page is reachable: the custom domain once active, else the platform address.
reply_to_email string
subscriber_count integer Confirmed, active subscribers. Only in GET /status-pages.

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.
400 file_empty The uploaded file is empty. When: Uploading a logo or image with no content. Fix: Upload a file that has content. Stable codes next to the English message when a logo is refused: file_empty, file_type_unsupported (error.details.formats lists the accepted ones), image_invalid (damaged or unreadable), image_dimensions_too_large (error.details.max_pixels), svg_unsafe. upload_no_file (the form has no file part) and upload_invalid (the upload could not be read) apply to multipart uploads.
413 file_too_large The uploaded file is over the size limit. When: Uploading a logo or image larger than details.max_bytes. Fix: Reduce the file size and upload again. file_too_large: the logo or favicon is larger than 256 KB (error.details.max_bytes). A proxy in front of the API may answer 413 with a plain HTML body and no code.
400 file_type_unsupported The file's type is not accepted for this upload. When: Uploading a file whose type is not one of the formats the operation accepts; details.formats lists them. Fix: Upload a file in one of details.formats.
400 image_dimensions_too_large The image has more pixels than allowed. When: Uploading an image with more pixels than details.max_pixels. Fix: Scale the image down and upload it again.
400 image_invalid The file is not a readable image. When: Uploading a file with an image type that cannot be decoded. Fix: Export the image again and upload the new file.
400 logo_fetch_failed The logo could not be fetched from the address given. When: Importing a client logo from a URL that cannot be reached or that does not return an acceptable image. Fix: Check the URL, or upload the logo file instead.
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.
400 svg_unsafe The SVG contains content that is not allowed. When: Uploading an SVG that contains a script, a foreignObject, a javascript: URL, an event-handler attribute or an external href. Fix: Remove those parts from the SVG, or upload a PNG or JPEG.
400 upload_invalid The upload could not be read as a multipart form. When: A body that is not a valid multipart form, or whose file cannot be parsed. Fix: Send a well-formed multipart/form-data request.
400 upload_no_file The multipart request has no file part. When: An upload request without a file field. Fix: Send the file as multipart/form-data in the field the operation names.

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