NAME

WebService::OPNsense::CaptivePortal::Settings - Captive portal settings controller

VERSION

version 0.002

SYNOPSIS

my $cp_settings = $opn->captive_portal_settings;

my $settings = $cp_settings->get_settings;

DESCRIPTION

Manages captive portal settings and zones.

METHODS

get_settings

my $settings = $cp_settings->get_settings;

Returns captive portal settings.

set_settings

my $result = $cp_settings->set_settings($settings_data);

Updates captive portal settings.

search_zones

my $zones = $cp_settings->search_zones(%params);

Searches for captive portal zones.

get_zone

my $zone = $cp_settings->get_zone($uuid);

Returns a single zone by UUID.

add_zone

my $result = $cp_settings->add_zone($zone_data);

Creates captive portal zone.

set_zone

my $result = $cp_settings->set_zone($uuid, $zone_data);

Updates zone.

del_zone

my $result = $cp_settings->del_zone($uuid);

Deletes a zone by UUID.

toggle_zone

my $result = $cp_settings->toggle_zone($uuid, $enabled);

Enables or disables a zone.

client

my $http_client = $cp_settings->client;

Returns the underlying HTTP client object used for API requests.

SEE ALSO

WebService::OPNsense::Role::Settings

AUTHOR

Dean Hamstead <dean@fragfest.com.au>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2026 by Dean Hamstead.

This is free software, licensed under:

The MIT (X11) License