Skip to content

Action

Manage Actions.

Create

Create an automated action.

Endpoint

HTTP
POST /action/create

Authorized User Role

admin

Request Body

FieldTypeRequiredNotes
argsobjectAction arguments.
bufferobjectMetric action buffering controls.
{ sum: number, count: number, elapsed: number, force: boolean}
Where "sum" is the total of metric values, "count" is the number of triggered actions, "elapsed" it the time in seconds to buffer the metric and "force" will force a write of the buffer metric data, .
cloudIdstringyesCloud ID.
contextobjectAction context.
descriptionstringAction description.
destinationstringAction destination.
enablebooleanAction enable flag.
errorstringAction error.
expressionstringAction expression.
formatstringAction format.
messagestringAction message.
namestringyesAction name.
pollnumberAction polling interval.
rearmnumberAction rearming interval.
severitystringAction severity.
triggerstringyesAction trigger.
typestringyesAction type.

Response

Action Record.

FieldTypeNotes
argsobjectAction args.
bufferobjectBuffer optimizations for metrics.
cloudIdstringOwning device cloud ID.
contextobjectTrigger expression context, merged with user params.
descriptionstringAction description.
destinationstringURL, email address, function name, topic, phone number.
duenumberWhen the action is next due.
enablebooleanEnable or disable the action.
errorstringError message from last invocation.
expressionstringTrigger expression.
formatstringMessage format.
idstringUnique action ID.
namestringAction name.
pollnumberDelay between pollng the trigger.
rearmnumberTime period to suppress triggering.
severitystringAlert severity.
triggerstringSource of action trigger.
typestringAction type.

Find

Find actions by cloud ID and optional type.

Endpoint

HTTP
POST /action/find

Authorized User Role

user

Request Body

FieldTypeRequiredNotes
cloudIdstringyesCloud ID.
typestringAction type.

Query String Options

FieldTypeDefaultNotes
indexstringIndex name: primary or gs1.
limitnumberLimit number of results.
nextobjectToken for next page.
prevobjectToken for previous page.

Response

Paged response.

FieldTypeNotes
dataarrayArray of matching actions.
nextstringPaged cursor to use for the next page of items.
prevstringPages cursor to use for the previous page of items.

Action

FieldTypeNotes
argsobjectAction args.
bufferobjectBuffer optimizations for metrics.
cloudIdstringOwning device cloud ID.
contextobjectTrigger expression context, merged with user params.
descriptionstringAction description.
destinationstringURL, email address, function name, topic, phone number.
duenumberWhen the action is next due.
enablebooleanEnable or disable the action.
errorstringError message from last invocation.
expressionstringTrigger expression.
formatstringMessage format.
idstringUnique action ID.
namestringAction name.
pollnumberDelay between pollng the trigger.
rearmnumberTime period to suppress triggering.
severitystringAlert severity.
triggerstringSource of action trigger.
typestringAction type.

Get

Get an action by cloud ID and action ID.

Endpoint

HTTP
POST /action/get

Authorized User Role

admin

Request Body

FieldTypeRequiredNotes
idstringyesAction ID.
cloudIdstringyesCloud ID.
typestringyesAction type.

Response

Action Record.

FieldTypeNotes
argsobjectAction args.
bufferobjectBuffer optimizations for metrics.
cloudIdstringOwning device cloud ID.
contextobjectTrigger expression context, merged with user params.
descriptionstringAction description.
destinationstringURL, email address, function name, topic, phone number.
duenumberWhen the action is next due.
enablebooleanEnable or disable the action.
errorstringError message from last invocation.
expressionstringTrigger expression.
formatstringMessage format.
idstringUnique action ID.
namestringAction name.
pollnumberDelay between pollng the trigger.
rearmnumberTime period to suppress triggering.
severitystringAlert severity.
triggerstringSource of action trigger.
typestringAction type.

Remove

Remove an action by cloud ID and action ID.

Endpoint

HTTP
POST /action/remove

Authorized User Role

admin

Request Body

FieldTypeRequiredNotes
idstringyesAction ID.
cloudIdstringyes

Update

Update an action by cloud ID and action ID.

Endpoint

HTTP
POST /action/update

Authorized User Role

admin

Request Body

FieldTypeRequiredNotes
argsobjectAction arguments.
bufferobjectAction buffering controls.
cloudIdstringyesCloud ID.
contextobjectAction context.
descriptionstringAction description.
destinationstringAction destination.
enablebooleanAction enable flag.
errorstringAction error.
expressionstringAction expression.
formatstringAction format.
idstringyesAction ID.
messagestringAction message.
namestringAction name.
pollnumberAction polling interval.
rearmnumberAction rearming interval.
severitystringAction severity.
triggerstringAction trigger.
typestringAction type.

Response

Action Record.

FieldTypeNotes
argsobjectAction args.
bufferobjectBuffer optimizations for metrics.
cloudIdstringOwning device cloud ID.
contextobjectTrigger expression context, merged with user params.
descriptionstringAction description.
destinationstringURL, email address, function name, topic, phone number.
duenumberWhen the action is next due.
enablebooleanEnable or disable the action.
errorstringError message from last invocation.
expressionstringTrigger expression.
formatstringMessage format.
idstringUnique action ID.
namestringAction name.
pollnumberDelay between pollng the trigger.
rearmnumberTime period to suppress triggering.
severitystringAlert severity.
triggerstringSource of action trigger.
typestringAction type.