New to Corsair? See API access, authentication, and error handling.
Commands
history
commands.history
Read the run history of one command, newest first
Risk: read
Returns the newest runs first. Take
command_id from commands.list.
Output
records full type
records full type
list
commands.list
List the commands configured on every computer, with the computer each belongs to
Risk: read
This route is a POST. Pass
computer_id to narrow to one computer.
Output
records full type
records full type
run
commands.run
Run a configured command on one of the account’s computers, with optional parameters
Risk: destructive
The response acknowledges dispatch, not completion. Omit
params rather than passing an empty string.
Output
Computers
list
computers.list
List the computers the agent has registered
Risk: read
records full type
records full type
Panels
list
panels.list
List the dashboard panel buttons and the parameters each carries
Risk: read
records full type
records full type
trigger
panels.trigger
Press a panel button, which runs the command it is configured for
Risk: destructive
Runs the command the button is configured for, with the button parameters.
Output