Skip to main content
POST
cURL

Body

application/json
​
CID
string

The opaque session ID token. Required for 7.2 controllers only.

​
action
string

The API action to perform. Required for 7.2 controllers only.

​
ahs_info_get
boolean

Get the controller AHS info, is SaaS or not.

​
banner_name_get
boolean

Get the controller name if there is one in DB.

​
banner_name_set
string

Set controller name to be used in the dashboard banner.

​
central_services_staging_mode
enum<string>

Enable/disable staging central services for controller HA.

Available options:
disable,
enable
​
cmd_backoff
boolean

Dummy command to tell the caller to back off.

​
ctrl_dns_name_get
boolean

Get the controller DNS name.

​
ctrl_dns_name_set
string

Set the controller DNS_name.

​
du_threshold_email_get
boolean

Get the controller disk usage threshold for email alert.

​
du_threshold_email_set
string

Set the controller disk usage threshold for email alert.

​
gateway_auto_recovery
enum<string>

Enable or disable gateway auto recovery.

Available options:
current_setting,
disable,
enable
​
mem_threshold_email_get
boolean

Get the controller memory usage threshold for email alert.

​
mem_threshold_email_set
string

Set the controller disk usage threshold for email alert.

​
onboot_upgrade_get
boolean

Get the flag of the controller onboot upgrade.

​
onboot_upgrade_set
string

Set the flag to enable or disable of onboot upgrade.

​
private_ip_mode
enum<string>

Enable private ip mode.

Available options:
current_setting,
disable,
enable
​
private_oob
enum<string>

Enable private oob.

Available options:
current_setting,
disable,
enable
​
public_dns
string

Provide a well known public DNS to use.

​
session_timeout_get
boolean

Get the controller session timeout value if there is one in DB.

​
session_timeout_set
string

Set controller session timeout value.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

​
errortype
string

Error type if the API failed.

​
reason
string

Failure reason if the API failed.

​
results

API response data

​
return
boolean

Whether the API returned successfully