API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read configuration of external captive portal

Use this API to configure external captive portal profiles for guest users. For AP and GW, When the captive portal profile is applied to an SSID or a wired profile, the users connecting
to the SSID or wired network are assigned a role with the captive portal rule. For CX, when the client is 802.1x or MAC authenticated through RADIUS-server, the redirect parameters in this
profile can be applied through user-role, Downloadable User Role and RADIUS Vendor Specific Attribute. This feature is applicable for AP, CX and GW.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

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