Docs

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

Sign in Start free

Recheck a custom domain

Rechecks custom-domain status and returns the current challenge, health and public addresses.

POST https://app.upfour.io/v1/status-pages/{pageID}/custom-domain/recheck
POST https://app.upfour.io/v1/status-pages/{pageID}/custom-domain/recheck

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
Headers

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 Idempotency-Key supported returns 200

Parameters

FieldTypeDescription
pageID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data StatusPageDomainDetails
StatusPageDomainDetails · 101 fields
FieldTypeDescription
page StatusPage · nullable
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.
platform_url string The page's address under the platform domain.
public_url string
challenge StatusPageDomainChallenge
StatusPageDomainChallenge · 14 fields
FieldTypeDescription
created_at string (date-time)
domain string
id uuid
organization_id uuid
pending_expires_at string (date-time)
status string one ofpending_dnsconflict_requires_review
status_page_id uuid
updated_at string (date-time)
error string
incumbent_organization_id uuid
incumbent_status_page_id uuid
last_checked_at string (date-time)
verification_token string
verified_at string (date-time)
cname_name string
cname_target string
entitlement StatusPageDomainEntitlement
StatusPageDomainEntitlement · 10 fields
FieldTypeDescription
can_purchase boolean
limit integer
metered boolean
over_limit boolean
pack_slots integer
paid_slots integer
plan_included integer
unit_price_cents integer
used integer
renew_at string (date-time)
health StatusPageDomainHealth
StatusPageDomainHealth · 5 fields
FieldTypeDescription
status string one ofunknownhealthyunhealthy
checked_at string (date-time)
error string
error_code string one ofdns_invalidrouting_uncheckedrouting_changedcertificate_uncheckedcertificate_not_readyhttps_unreachableunknown
next_check_at string (date-time)
problem_code string one ofdns_not_foundtxt_not_foundhosting_setup_failedhosting_routing_failedhttps_pendinghttps_unreachablepublic_page_mismatchpublic_page_unreachableremoval_delayedclaim_releasedunknown
txt_name string
txt_value string

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.
403 permission_denied The credentials do not permit this action.

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