Enable, disable, run, or reconfigure a rule

PUT 
/events/:rule_name

Requires system-settings.manage and rule_action. Body is unused for enable/disable. run-job and update-config need a body only for some rules. A rule that is not allowed for that action returns IPV-1002, except update-config on an unsupported name returns no body.

Request

Responses

200

enable-rule: "Successfully enabled rule: {name}". disable-rule: "Successfully disabled rule: {name}". run-job: "Triggered the job {name}". update-config: "Updated the {name} parameters.". enable/disable may still return 200 after an AWS failure if the success Message was already set.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

{"Message": " - "}. IPV-1002 (bad rule_action or rule not allowed for that action), IPV-1008 (missing/extra body key), IPV-1005 (BDA region), IPV-1062 (wrong types), GE-1034 (job/backfill limits; HTTP 400 here), LOG-1008 (older than log retention), AUTH-1001, AUTH-1030 (system-settings.manage).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

enable/disable environment-prefix failure becomes RTE-1001 (message unset). Other uncaught errors use {"Message": "RTE-1001 - ."}. Invalid JSON body for update-config is also this path.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers