POST /accounts/{account_id}/cloudforce-one/rules

Create a new detection rule.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Cloudflare account ID.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
actions[] Array No
actions[].action_config Object Yes

Action-specific configuration parameters.

actions[].action_config.realtimekit_success Boolean No
actions[].action_config.cc_ExecFormParam String No
actions[].action_config.r2_messages[] Array No
actions[].enabled Boolean No

Default value: true

actions[].action_type String Yes

Valid values:

  • "remediation"
  • "throttle"
  • "email"
  • "delete"
  • "alert_gchat"
  • "logging"
  • "webhook"
  • "pipeline"
name String Yes
description String No

Human-readable description of the rule. Auto-extracted from YARA meta if present.

is_public Boolean No

Whether this rule is visible to other internal accounts.

Default value: false

content String Yes
enabled Boolean No

Whether this rule is active for dice consumers.

Default value: true

namespaces[] Array No

Optional WfP deployment tags (customer rules only). Internal rules leave empty.

path String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.