GET /accounts/{account_id}/cloudforce-one/rules/search
Search rules using hybrid, vector, keyword, or exact retrieval, backed by AI Search with a SQL fallback.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id |
String | Yes |
Cloudflare account ID. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
query |
String | Yes |
Natural-language or keyword search query. |
namespace |
No |
Selects namespaces. Repeat the parameter to select multiple namespaces (for example, namespace=foo&namespace=bar). |
|
limit |
Number | No |
Default value: 50 |
is_public |
String | No |
Limits rules to the specified public visibility. Valid values:
|
search |
String | No | |
recursive |
String | No |
For customer accounts, true enables descendant matching for namespaces. Paths always use exact matching. Valid values:
|
mode |
String | No |
Retrieval strategy used for the query. Valid values:
Default value: "hybrid" |
path |
No |
Selects paths with exact-match semantics. Omit the parameter to return rules from all paths. Pass an empty string (path=) to return only rules with an empty or uncategorized path. Pass a value (for example, path=yara) to match that exact path. Repeat the parameter (for example, path=yara&path=expr) to OR-match multiple paths with SQL |
|
offset |
Number | No |
Default value: 0 |
language |
String | No |
Limits results to the specified rule language. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.