Returns a list of logs of the configuration changes in the platform.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | string | optional | Pass the page number to retrieve logs. |
| page_size | string | optional | Pass the number of logs to retrieve per page. |
| user_id | string | optional | Pass the unique ID of a user to filter logs. |
| created_from | string | optional | Pass the created time in epoch format from which you want to retrieve logs. |
| created_to | string | optional | Pass the created time in epoch format until which you want to retrieve logs. |
| section | string | optional | Pass the configuration section to filter logs. To retrieve the name of the sections, use the GET List Configuration Sections API. |
| action | string | optional | Pass the action type to filter logs. |
| entity_type | string | optional | Pass the entity type of the configuration that is modified. |
| field | string | optional | Pass the name of a field to filter logs. |
| sort | string | optional | Pass the parameter to sort logs. By default logs are returned in descending order (latest logs are returned first) based on the created time. |
| q | string | optional | Pass the query text to search logs. |
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/event-logs/audit-logs/?page=1&page_size=10&user_id=41755c7b-8370-456c-88b4-3df6c767e896&created_from=1704067200&created_to=1704758399§ion=Configuration&action=ADD&entity_type=User&field=is_active&sort=-created&q=tenant&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/event-logs/audit-logs/?page=1&page_size=10&user_id=41755c7b-8370-456c-88b4-3df6c767e896&created_from=1704067200&created_to=1704758399§ion=Configuration&action=ADD&entity_type=User&field=is_active&sort=-created&q=tenant&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/event-logs/audit-logs/"
params = {
"page": "1",
"page_size": "10",
"user_id": "41755c7b-8370-456c-88b4-3df6c767e896",
"created_from": "1704067200",
"created_to": "1704758399",
"section": "Configuration",
"action": "ADD",
"entity_type": "User",
"field": "is_active",
"sort": "-created",
"q": "tenant",
"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": "audit-logs/?page=2&page_size=10",
"previous": {},
"total": 1734,
"page_size": 10,
"results": [
{}
]
}View-only example — running live API calls requires a role with snippet testing access.