API Reference

Perform action on a single device

post
https://api.controlup.com/edge/api/devices//actions

Performs an action on the specified device.

Required permissions - Depending on the action performed:

  • Run Command
  • Send Message
  • Power Actions
  • Terminate Process
  • Run Ungrouped Scripts
  • Run Group 1/2/3/4/5 Scripts
Path Params
string
required

ID of the device on which to perform the action. You can use GET /devices to see the ID for each device.

Body Params

Select the type of action you want to perform to see the required payload. There are payload request samples for each type of action.

string
enum

The type of action to perform. To run a command as System/Root, enter DEV_RUNCMD.

Allowed:
string

The command to run.

Responses
202

Action request successfully sent.

400

Invalid request payload.

500

Something went wrong at the API service.

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 5 months ago

Did this page help you?