API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Update existing external captive profile configuration

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/captive-portal/

Captive portal profile configuration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

The name of the captive portal profile.

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

allow-list
array of strings
length ≤ 2147483647
allow-list
boolean
Defaults to false

Add AP's MAC address in redirection URL.

boolean
Defaults to false

To bypass Apple CNA on iOS devices like iPad, iPhone, iPod.

string
enum
Defaults to PAP

Authentication Protocol to be used.

Show Details
CHAPUse CHAP (non-standard) to authenticate user.
MSCHAPv2Use MSCHAPv2 to authenticate user.
PAPUse PAP to authenticate user.
Allowed:
string
length between 1 and 63

Default guest user role.

string
length between 1 and 63

Default user role.

deny-list
array of strings
length ≤ 2147483647
deny-list
string
length between 1 and 256

Description, or comment, for the Captive Portal profile.

boolean
Defaults to true

Enable the welcome page before redirection to original destination.

string
length between 1 and 1024

The URL for the external captive portal server, URL format:http(s)://:/path.

boolean
Defaults to false

Allow guest user login.

string
length between 1 and 64

Add one of the controller interfaces in the redirection URL.

int32
0 to 100
Defaults to 60

Logon wait when CPU is overloaded, CPU utilization threshold (%). Range: 1-100. Default: 60.

int32
0 to 10
Defaults to 10

Logon wait when CPU is overloaded,Maximum wait (secs).

int32
0 to 10
Defaults to 5

Logon wait when CPU is overloaded, minimum wait (secs).

boolean
Defaults to true

Open popup window for logout after authentication.

int32
0 to 10
Defaults to 0

Maximum auth failures before user is added to denylist.Range: 0-10. Default: 0.

string
length between 1 and 128

The name of the captive portal profile.

string
length between 1 and 255

Configures a URL to redirect the users when the internet uplink is down.

boolean
Defaults to false

When the Prevent frame overlay option is enabled, a frame can display a page only if it is in the same domain as the main page.

int32
0 to 60
Defaults to 10

Pause time for automatic redirect.Range: 1-60, 0 to disable. Default: 10.

string
length ≤ 9999

Specify a redirect URL to redirect users to another URL.

boolean
Defaults to false

Allow the guest clients to access Internet when the external captive portal server is not available.

string
length between 1 and 80

Associate to a server group.

boolean
Defaults to false

Enables the server-offload feature to reduce the load on the external captive portal server by allowing the Instant AP to use a Meta tag to redirect HTTP and HTTPS requests from the client.

boolean
Defaults to false

Show the acceptable use policy page before the logon page.

boolean
Defaults to false

Allow user to see and select FQDN.

boolean
Defaults to false

Allow only one active user session at a time.

boolean
Defaults to false

Sends the IP address of the virtual controller in the redirection URL when external captive portal servers are used.

string
length between 1 and 224

Hash the redirection URL using this key in ciphertext format.

string
enum

Hash Key format.

Show Details
CIPHER_TEXTConfigure hash-key in ciphertext.
PLAIN_TEXTConfigure hash-key in plaintext.
Allowed:
string
length ≤ 9999

Hash the redirection URL using this key.

boolean
Defaults to true

Enforce clients to use HTTPS to communicate with the authentication server

int64
30 to 1296000

User idle timeout value. Valid range is 30-1296000 seconds in multiples of 30 seconds

boolean
Defaults to true

Allow registered user login.

boolean
Defaults to false

Add user VLAN in redirection URL.

string
length between 1 and 256
Defaults to /auth/welcome.html

Alternate welcome page to show after authentication.

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago