HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Generic commands for device

This API will help to send following commands given below to specific device specified by its serial.

  1. reboot: This command performs a reboot of the device, supported by IAP/Controllers/MAS Switches/Aruba Switches

  2. blink_led_on: Use this command to enable the LED display, supported by IAP/Aruba Switches

  3. blink_led_off: Use this command to disable the LED display, supported by IAP/Aruba Switches

  4. blink_led: Use this command to blink LED display, supported only for Aruba Switches alone

  5. erase_configuration : This command can be used to erase the running configuration and return to factory default setting, supported only for Aruba Switches alone

  6. save_configuration: This command saves the running configuration to memory and displays the running configuration on the screen, supported by IAP/Aruba Switches

  7. halt : This command performs a shutdown of the device (it will not reboot), supported by Controllers alone

  8. config_sync : This commands performs full refresh of the device config, supported by Controllers alone

Possible error_codes for the error responses are:

  1. 0001 - General Error.
  2. 0004 - Validation Error. Invalid value for a query parameter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Serial of device

string
required

Command mentioned in the description that is to be executed

Responses

401

Unauthorized

403

Forbidden

404

Not found

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

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