API Reference

Creates a Rule

post
https://api.edgeiq.io/api/v1/platform/rules

Rules are used to classify rules, which represent specific, addressable instances of that class of rule.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The general description for users.

rule_condition
object

A boolean condition that is run against a report payload. In a rule condition, when specifying the payload field to inspect, dot notation may be used for nested fields. Parent_or_sibling_key/value may be used for finding nested fields that may be in arrays.

then_actions
array of objects

The rule actions that will be executed if the rule condition evaluates to true.

then_actions
else_actions
array of objects

The rule actions that will be executed if the rule condition evaluates to false.

else_actions
boolean
Defaults to true

Indicates if the rule is active.

boolean
Defaults to false

Does this rule run in the cloud (true) or edge (false).

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Updated 8 months ago

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

Updated 8 months ago