API Reference

Start Action

post
https://api.controlup.com/vdi/realtime/v1/actions/start

Starts an action on up to 100 records of a table. Returns an operation ID that can be used with the status endpoint to track progress and retrieve results

Body Params
string
required

The ID of the action to start

string
required

The metrics table the records belong to

recordIds
array of strings
required
length between 1 and 100

IDs of the records to run the action on

recordIds*
boolean

Whether the action may also be applied recursively to related records

userInput
object

Values for the action's input parameters, keyed by parameter name. Duplicate keys are rejected

Responses

Updated about 17 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 17 hours ago

Did this page help you?