Skip to main content
POST
Create a walled garden entry

Authorizations

Authorization
string
header
required

API Key authentication. Provide your token in the 'Authorization' header. Example: Authorization: Bearer <YOUR_TOKEN>

Path Parameters

siteId
string<uuid>
required

The unique identifier for the site.

Example:

"a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6"

Body

application/json
name
string
required

A descriptive name for the entry.

Example:

"Google Authentication Servers"

ip_address
string
required

The IP address or subnet in CIDR notation to allow. Must be a valid RFC 4632 address.

Example:

"172.217.16.0/24"

type
enum<string> | null

An optional type to categorize the entry.

Available options:
captive-auth,
captive-portal
Example:

"captive-auth"

Response

The walled garden entry was created successfully.

id
string<uuid>

The unique identifier for the walled garden entry.

Example:

"f1e2d3c4-b5a6-9876-5432-10fedcba9876"

name
string

A descriptive name for the entry.

Example:

"Google Authentication Servers"

type
enum<string> | null

The type of service this entry is for.

Available options:
captive-auth,
captive-portal
Example:

"captive-auth"

ip_address
string

The IP address or subnet in CIDR notation that is allowed pre-authentication.

Example:

"172.217.16.0/24"

created_at
string<date-time>

The timestamp when the entry was created.

Example:

"2025-10-27T18:00:00Z"