Runs a report and sends the file to the recipients.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| report_id | string | optional | Pass the ID of a report. For example: 87c07bb3-b60c-4279-a5ec-8a38f73f7ea4. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| type | string | required | Pass the type of report to run. |
Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| file_types | array | optional | Pass the report types. |
| internal_recipients | object | required | Pass the list of details of internal users to share the report. Note: At least one internal or external recipient is required. |
| query_key | string | required | Pass the value to specify whether the report must run based on the created time or the last modified time of threat data in CTIX. |
| starttime | number | required | Pass the start date and time in EPOCH format from which the report captures data available in CTIX. |
| endtime | number | required | Pass the end date and time in EPOCH format until which the report captures data available in CTIX. |
| external_recipients | object | required | Pass the list of external users to share the report. Note: At least one internal or external recipient is required. |
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 POST \
--url "https://cs-testv2.cyware.com/ctixapi/ingestion/reports/%7B%7Breport_id%7D%7D/run/?type=basic&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E" \
--data '{
"file_types": [
"csv"
],
"internal_recipients": {},
"query_key": "ctix_created",
"starttime": 1752834255,
"endtime": 1753439055,
"external_recipients": {}
}'View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/ingestion/reports/%7B%7Breport_id%7D%7D/run/?type=basic&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "POST",
headers: {},
body: JSON.stringify({
"file_types": [
"csv"
],
"internal_recipients": {},
"query_key": "ctix_created",
"starttime": 1752834255,
"endtime": 1753439055,
"external_recipients": {}
}),
});
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/reports/%7B%7Breport_id%7D%7D/run/"
params = {
"type": "basic",
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
payload = {
"file_types": [
"csv"
],
"internal_recipients": {},
"query_key": "ctix_created",
"starttime": 1752834255,
"endtime": 1753439055,
"external_recipients": {}
}
response = requests.request("POST", url, params=params, headers=headers, json=payload)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"file_types": [
"csv"
],
"internal_recipients": {},
"query_key": "ctix_created",
"starttime": 1752834255,
"endtime": 1753439055,
"external_recipients": {}
}View-only example — running live API calls requires a role with snippet testing access.
{
"result": "Your Report will be mailed to you as soon as it is ready."
}View-only example — running live API calls requires a role with snippet testing access.