Get Asset
Streams an asset by id for the calling customer. Serves everything the public mount serves, plus the owner-only assets belonging to the caller's own organization (support attachments, service configs, server backups). Owner-only responses are marked privately cacheable and short-lived; publicly readable ones carry the same day-long public caching as the public mount.
path Parameters
idGet Asset › Responses
no content
Get Public Asset
Streams a publicly readable asset by id: catalog icons, reseller icons and OG images, and avatars. Requires no authentication, and reads no caller identity even if one is presented. An asset whose kind is owner-scoped (support attachments, service configs, server backups) is reported as forbidden here regardless of who asks -- fetch those from the console mount instead. Responses are cacheable for a day; the id is not a content hash, so replacing an icon reuses it.
path Parameters
idGet Public Asset › Responses
no content
Get Reseller Branding By Hostname
Resolves a storefront's branding from the hostname it is served on: name, brand colour, logo, Discord invite and OpenGraph image. Unauthenticated, because a storefront has to paint itself before anybody has logged in, and therefore deliberately narrow. A hostname belonging to no live, enabled reseller answers 404.
path Parameters
hostnameGet Reseller Branding By Hostname › Responses
The storefront's public branding
brand_colorcustom_plan_selector_enabledhostnameidnameog_image_modeOne of platform, logo, custom, disabled.
discord_invite_urlicon_asset_idresolved_og_image_asset_idSee [ResellerResponse::resolved_og_image_asset_id].
Get Public Captcha Config By Hostname
Resolves the captcha configuration a browser must honour for the host it is on: provider, public site key, and which actions (login, register, password reset and so on) require a solved challenge. Unauthenticated, because it has to answer before anyone has signed in -- that is the whole point of a pre-login captcha. Never returns a secret key; there is no secret field on this response at all. A hostname matching a live, enabled reseller answers that reseller's own configuration; any other hostname, including one belonging to no reseller at all, answers the platform's. Never 404s: an unmatched or malformed hostname resolves to the platform default rather than an error.
path Parameters
hostnameGet Public Captcha Config By Hostname › Responses
The captcha configuration this host's visitors must honour
enabledWhether any action on this host requires a solved challenge at all. false
for a missing config, a disabled one, or one missing a key -- see
CaptchaConfig::is_active.
protected_actionsStable snake_case action names the widget is required for. Empty when
enabled is false.
providerProvider wire value, e.g. turnstile. Always present, even when enabled is
false, so a client can wire up the right widget component ahead of a
provider ever being turned on.
site_keySafe to render in a browser; this is the half of the key pair that is meant
to be public. None exactly when enabled is false.
List Public Incidents
Lists the platform incidents that are happening right now, for the customer-facing outage banner. Deliberately unauthenticated: the moment this read matters most is the one where the caller cannot sign in. Resolved incidents are never returned, and each entry carries only the headline, the optional detail text and when it began.
List Public Incidents › Responses
The ongoing incidents, oldest first. An empty array means all clear.
titleThe headline to show.
idA stable key for deduplicating a poll or remembering a dismissal.
started_atWhen the incident began, so the banner can date itself.
messageFurther detail, if the operator published any.
List Public Maintenance Windows
Lists the maintenance windows that have not been cancelled and are scheduled no earlier than 24 hours ago, soonest first, for the customer-facing maintenance banner. Deliberately unauthenticated. Each entry carries only the headline, the start and the expected duration.
List Public Maintenance Windows › Responses
The upcoming maintenance windows. An empty array means none is planned.
titleThe headline to show.
idA stable key for deduplicating a poll or remembering a dismissal.
scheduled_atWhen the maintenance is scheduled to begin.
expected_duration_minutesHow long it is expected to last, if staff said.
Report Client Error
Records one client-side crash from a browser, for the platform's own diagnostics. Deliberately unauthenticated: the crashes worth hearing about include the ones that happen before, or instead of, a caller being able to sign in. Answers 204 unconditionally -- a crash reporter that returns an error makes the crash worse -- so a success here means the report was accepted, never that it was stored. message is truncated to 2000 characters and stack to 8000; an over-long report is shortened, never rejected. Rate limited per source address.
Report Client Error › Request Body
error_idThe reporter's own correlation id for this crash, echoed back to the user so a support conversation can name it. Caller-supplied and caller-shaped; see this module's doc comment for why it is not a key.
messageThe error message. Truncated to 2000 characters on the way in.
digestNext.js's build-time error digest, when the crash came from a server component and the framework withheld the real message from the browser. Absent for a plain client-side throw.
stackThe stack trace. Truncated to 8000 characters on the way in.
urlThe page the crash happened on.
user_agentThe browser, as the browser describes itself.
Report Client Error › Responses
Accepted. Returned even if the report failed to persist, and even if it was truncated.
Get Deployment Capabilities
Says which optional capabilities this deployment runs. A partner who hosts their own kernel may leave registry, payment providers, object storage pools, the unit log and metrics stores, Domain Connect, mail and similar unconfigured; a capability answering false is absent here. Its routes refuse with 501 capability-not-available, its products are not in the catalog, and clients must not render its UI. A pool or processor that cannot be read at this moment reports false.
Get Deployment Capabilities › Responses
What this deployment runs
container_registryCustomer container registries. Registry products are not listed when false.
domain_connectDomain Connect one-click DNS setup.
mailTransactional email. Without it no mail is ever sent (verification, password reset and notifications included).
mollieMollie card checkout for invoices.
nowpaymentsNOWPayments crypto checkout.
object_storage_bucketsCustomer object-storage buckets. Bucket products are not listed when false.
paypalPayPal checkout (wallet top-ups and invoice payment).
unit_log_storeStored unit log history. Live tail is unaffected.
unit_metrics_storeStored unit metrics history.
wardenThe Warden edge protection listener.
web_pushWeb Push notifications.
