Retrieves a list of rules from the platform.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | string | optional | Pass the page number to retrieve rules. |
| page_size | string | optional | Pass the number of rules to retrieve on each page. |
| source | string | optional | Pass a comma-separated list of source IDs to filter rules. |
| created_by_id | string | optional | Pass the ID of the creator of the rules to filter. |
| status | string | optional | Pass the status of the rules. By default, rules with all statuses are retrieved. |
| last_active_to | string | optional | Pass the last active time in epoch format to filter rules. |
| last_active_from | string | optional | Pass the last active time in epoch format to filter rules. |
| created_from | string | optional | Pass the creation time in epoch format to filter rules. |
| created_to | string | optional | Pass the creation time in epoch format to filter rules. |
| is_manual_run | string | optional | Pass true to retrieve rules that are configured for manual execution only. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request GET \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/rules/?page=1&page_size=10&source=3f9a5d74-3f63-4fee-95cf-f25c809cc2xx%2C3f9a5d74-3f63-4fee-95cf-f25c809cc2yy&created_by_id=3f9a5d74-3f63-4fee-95cf-f25c809cc2zz&status=ACTIVE&last_active_to=1703743485&last_active_from=1703743400&created_from=1703743401&created_to=1703743486&is_manual_run=true&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E"View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/rules/?page=1&page_size=10&source=3f9a5d74-3f63-4fee-95cf-f25c809cc2xx%2C3f9a5d74-3f63-4fee-95cf-f25c809cc2yy&created_by_id=3f9a5d74-3f63-4fee-95cf-f25c809cc2zz&status=ACTIVE&last_active_to=1703743485&last_active_from=1703743400&created_from=1703743401&created_to=1703743486&is_manual_run=true&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "GET",
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/ingestion/rules/"
params = {
"page": "1",
"page_size": "10",
"source": "3f9a5d74-3f63-4fee-95cf-f25c809cc2xx,3f9a5d74-3f63-4fee-95cf-f25c809cc2yy",
"created_by_id": "3f9a5d74-3f63-4fee-95cf-f25c809cc2zz",
"status": "ACTIVE",
"last_active_to": "1703743485",
"last_active_from": "1703743400",
"created_from": "1703743401",
"created_to": "1703743486",
"is_manual_run": "true",
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
response = requests.request("GET", url, params=params, headers=headers)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"next": {},
"previous": {},
"page_size": 10,
"total": 5,
"results": [
{}
]
}View-only example — running live API calls requires a role with snippet testing access.