Skip to content

Captive portal

A guest-capture portal for hospitality properties: the public page collects a visitor, the back end keeps the record.

appLines of business15 operationsid captive

How it sits

An app is already assembled from parts, with a face of its own. The counts and the links below are from the platform's spec and the other services' own descriptions.

Among the partsfrom the spec
Operations15 GET 13 · POST 2
Resources11
Leaned on byno other service names it
Leans onDatabase, UniFi
In recipesnone yet

What it can do

15 operations in 11 resources, as the spec declares them. Each row is one call; paths are relative to the part.

guests

MethodPathDoes
GET/api/v1/guestsList captured guests (PII)
GET/api/v1/guests/export.csvCSV export of captured guests (PII)
2 operations

health

MethodPathDoes
GET/healthBasic health check
GET/health/detailedDetailed health check
2 operations

p

MethodPathDoes
GET/p/{property_key}Captive portal page
GET/p/{property_key}/logo.pngProperty logo asset
2 operations

portal

MethodPathDoes
POST/api/portal/{property_key}/connectContact-info connect
POST/api/portal/{property_key}/voucherVoucher-code connect
2 operations

activity

MethodPathDoes
GET/api/v1/activityRecent authorizations (activity log)
1 operation

config

MethodPathDoes
GET/api/v1/configNon-secret wiring status
1 operation

guest

MethodPathDoes
GET/guest/s/{site_name}/UniFi external-portal redirect target
1 operation

prime

MethodPathDoes
GET/primePrime application caches
1 operation

stats

MethodPathDoes
GET/api/v1/statsGuest-funnel stats
1 operation

status

MethodPathDoes
GET/statusService status overview
1 operation

vouchers

MethodPathDoes
GET/api/v1/vouchers/redemptionsPer-code voucher redemption counts (external-portal truth)
1 operation

All the partsLines of businessThe platform's own id for this service is cbcaptive.

forge-catalog.json, generated Oct 30, 2026

Anti-cloud. Host local, think global.

Terminal
/terminal