Skip to main content
GET
/
instances
/
{instanceId}
Retrieve a captive portal instance
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "auth_integration_id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
  "strategy": "oauth2",
  "name": "Main Office Guest WiFi",
  "session_ttl": 43200,
  "auth_window_ttl": 300,
  "theme": {
    "logo": "https://api.altostrat.io/captive/assets/.../logo_abc123.png?signature=...",
    "icon": "https://api.altostrat.io/captive/assets/.../icon_def456.png?signature=...",
    "accent_text": "#FFFFFF",
    "accent_color": "#0396d5",
    "text_color": "#4f4f4f",
    "secondary_text_color": "#8f8f8f",
    "background_color": "#f9f9f9",
    "border_color": "#e0e0e0",
    "box_color": "#ffffff"
  },
  "terms_text": "By connecting, you agree to our terms of service...",
  "sites": [
    {
      "id": "a1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
      "subnets": [
        "192.168.88.0/24"
      ]
    }
  ],
  "created_at": "2025-10-29T12:00:00Z",
  "preview_url": "https://captive.altostr.at/preauth?token=eyJpdiI6..."
}

Authorizations

โ€‹
Authorization
string
header
required

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

Path Parameters

โ€‹
instanceId
string<uuid>
required

The unique identifier for the captive portal instance.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

Response

The requested captive portal instance.

โ€‹
id
string<uuid>

The unique identifier for the instance.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

โ€‹
auth_integration_id
string<uuid> | null

The ID of the authentication integration used if the strategy is 'oauth2'. Null for 'coupon' strategy.

Example:

"c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f"

โ€‹
strategy
enum<string>

The authentication method for this captive portal.

Available options:
oauth2,
coupon
Example:

"oauth2"

โ€‹
name
string

A human-readable name for the instance.

Example:

"Main Office Guest WiFi"

โ€‹
session_ttl
integer

The duration in seconds that a user's session remains active after successful authentication.

Example:

43200

โ€‹
auth_window_ttl
integer

For OAuth2 strategy, the duration in seconds that the walled garden is temporarily opened to allow the user to complete authentication with the identity provider.

Example:

300

โ€‹
theme
object

A collection of branding and appearance settings.

โ€‹
terms_text
string | null

The text of the terms and conditions that can be displayed to the user.

Example:

"By connecting, you agree to our terms of service..."

โ€‹
sites
object[]

A list of sites and their subnets where this captive portal instance is active.

โ€‹
created_at
string<date-time>

The timestamp when the instance was created.

Example:

"2025-10-29T12:00:00Z"

โ€‹
preview_url
string<uri> | null

A temporary, signed URL to preview the captive portal's appearance.

Example:

"https://captive.altostr.at/preauth?token=eyJpdiI6..."