Skip to main content
POST
/
walled-garden
/
{site}
Create a new walled garden entry for a site
curl --request POST \
  --url https://api.altostrat.io/walled-garden/{site} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "ip_address": "<string>",
  "type": "captive-auth"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "<string>",
  "ip_address": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

site
string<uuid>
required

UUID of the Site to manage walled garden entries

Body

application/json

Data for creating a walled garden entry

name
string
required
ip_address
string
required

RFC 4632 address or prefix to add to the walled garden

type
enum<string> | null
Available options:
captive-auth,
captive-portal

Response

Walled garden entry created

id
string<uuid>
name
string
type
string

Type of walled-garden entry, defaults to captive-auth

ip_address
string

A single IP address or prefix displayed for reference

created_at
string<date-time>
I