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

Read a custom message

get
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/custom-messages/

A custom message can be used with Central NAC portal profiles and visitor
management facilities to provide customized email and SMS messages for
Central NAC visitors.

Path Params
string
required
length ≤ 9999

Unique identifier for the custom message (must be a UUID).

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

Updated 7 days ago

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