Returns a list of canvases.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| created_by_id | string | optional | Pass the ID of the creator. |
| q | string | optional | Pass the query text to search for threat investigations by the title. |
| shared_type | string | optional | Pass the sharing type to filter. |
| created_from | string | optional | Pass the created time in epoch format to filter results. |
| created_to | string | optional | Pass the created time in epoch format to filter results. |
| page | string | optional | Pass the page number to retrieve records. |
| page_size | string | optional | Pass the number of records to retrieve on each page. |
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/canvas/?created_by_id=1234&q=canvas&shared_type=private&created_from=1633067201&created_to=1633067253&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/canvas/?created_by_id=1234&q=canvas&shared_type=private&created_from=1633067201&created_to=1633067253&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/canvas/"
params = {
"created_by_id": "1234",
"q": "canvas",
"shared_type": "private",
"created_from": "1633067201",
"created_to": "1633067253",
"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": {},
"total": 4,
"page_size": 10,
"results": [
{}
]
}View-only example — running live API calls requires a role with snippet testing access.