Skip to content
Support
Whitelisting

Whitelisting

API family for allow-listing device MAC addresses so they bypass the Captive Portal on a Sign-In Context.

Whitelisting lets specific devices connect to the Sign In SSID without going through a sign-in flow. Use this family for long-running fixtures (printers, kiosks, IoT devices) or for temporary bypass entries with an expiry date.

Validation rules

Section titled “Validation rules”

Shared across every endpoint in this family:

  • MAC — either AA:BB:CC:DD:EE:FF or AA-BB-CC-DD-EE-FF.
  • Name — 2–100 characters. Allowed: alphanumeric plus å ä ö Å Ä Ö & - , . and space.
  • Description — 0–200 characters, same character set as Name.
  • Tag value — 2–30 characters. Allowed: alphanumeric plus å ä ö Å Ä Ö ( ) & - , . / " + : and space.
  • Expiry (toDate) — YYYY-MM-DD. Entry is removed at 00:00 Organization-local time on this date. Omit or set null for permanent entries.

Prerequisites

Section titled “Prerequisites”
  • The target Sign-In Context has the Whitelist module enabled.
  • Your integration has the Context API key and an approved source IP.

See API overview for the common auth, base URL, and status-code model.

Error body

Section titled “Error body”

Validation errors in this family return a JSON array of field-level errors, one per field that failed:

[
  {
    "field": "mac",
    "rejectedValue": "00-11",
    "message": "invalid MAC address format"
  }
]
  • field — the request-body field that failed validation.
  • rejectedValue — the value that was submitted.
  • message — human-readable description of the rule that failed.

Operations

Section titled “Operations”

Create whitelisting

POST .../modules/whitelistings

Update whitelisting

PUT .../modules/whitelistings

Batch-add

POST .../modules/whitelistings/batch/add

Batch-revoke

POST .../modules/whitelistings/batch/remove

List active

GET .../modules/whitelistings/active

Next

Create whitelisting

Allow a single device MAC to bypass the Captive Portal.

Update whitelisting

Edit an existing whitelist entry's name, description, expiry, or tags.