Rule Engine

Manage the rule engine.

Get CloudGateway

Retrieve the rule engine.

enapter3 rule-engine get [--api-allow-insecure] [--api-url=""] [--verbose]

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Suspend CloudGateway

Suspend execution of rules.

enapter3 rule-engine suspend [--api-allow-insecure] [--api-url=""] [--verbose]

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Resume CloudGateway

Resume execution of rules.

enapter3 rule-engine resume [--api-allow-insecure] [--api-url=""] [--verbose]

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Rule

Manage rules.

Create CloudGateway

Create a new rule.

enapter3 rule-engine rule create --script="" [--slug=""] [--disable] [--exec-interval=] [--runtime-version=""] [--api-allow-insecure] [--api-url=""] [--verbose]

--script=required

Path to the file containing the script code.

--slug=

Slug for the new rule.

--disable

Disable the rule upon creation.

--exec-interval=

How frequently to execute the script (only compatible with runtime version 1) in duration format (e.g., 5s, 2m) (default: 0s).

--runtime-version=

Version of the runtime to use for the script execution (default: V3)

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Delete CloudGateway

Delete a rule.

enapter3 rule-engine rule delete --rule-id="" [--exec-interval=] [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule ID or slug.

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Disable CloudGateway

Disable one or more rules.

enapter3 rule-engine rule disable --rule-id="" [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule IDs or slugs.

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Enable CloudGateway

Enable one or more rules.

enapter3 rule-engine rule enable --rule-id="" [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule IDs or slugs.

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Get CloudGateway

Retrieve a rule.

enapter3 rule-engine rule get --rule-id="" [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule ID or slug.

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

List CloudGateway

List rules.

enapter3 rule-engine rule list [--api-allow-insecure] [--api-url=""] [--verbose]

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Update CloudGateway

Update a rule

enapter3 rule-engine rule update --rule-id="" --slug="" [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule ID or slug to update.

--slug=

A new rule slug.

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Update Script CloudGateway

Update the script of a rule.

enapter3 rule-engine rule update-script --rule-id="" --script="" [--exec-interval=""] [--runtime-version=""] [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule ID or slug to update.

--script=required

Path to the file containing the script code.

--exec-interval=

How frequently to execute the script (only compatible with runtime version 1) in duration format (e.g., 5s, 2m) (default: 0s).

--runtime-version=

Version of the runtime to use for the script execution (default: V3)

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.

Logs CloudGateway

Show rule logs.

enapter3 rule-engine rule logs --rule-id="" --follow="" [--api-allow-insecure] [--api-url=""] [--verbose]

--rule-id=

Rule ID or slug to update.

--follow, -f=required

Follow the log output.

--api-allow-insecure

Allows insecure connections to the Enapter API.

--api-url=string

Overrides API base URL (default: "https://api.enapter.com").

--verbose

Logs extra details about the operation.