POST /api/v2/audit_logs/export
Allowed For
- Admins on accounts that have audit log access
Limits
This endpoint's rate limit is different from the account-wide rate limit. The rate limit is one request per minute per account. When this limit is reached, you'll get a 429 Too Many Requests response code.
Headers
API responses include usage limit information in the headers for this endpoint.
Zendesk-RateLimit-audit-logs-export: total={number}; remaining={number}; resets={number}
Within this header, “Total” signifies the initial allocation, “Remaining” indicates the remaining allowance for the current interval, and “Resets” denotes the wait time in seconds before the limit refreshes. You can see the Total, and Interval values in the below table.
Details
The rate limit is one request per minute per account. If you exceed this, you'll receive the following error: "Rate limit for Audit log CSV Export exceeded. Please wait 1 minute and try again."
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter[source_type] |
String | No |
Filter audit logs by the source type. For example, user or rule |
filter[actor_id] |
Integer | No |
Filter audit logs by the actor id |
filter[ip_address] |
String | No |
Filter audit logs by the ip address |
filter[action] |
String | No |
Filter audit logs by the action |
filter[source_id] |
Integer | No |
Filter audit logs by the source id. Requires |
filter[created_at] |
String | No |
Filter audit logs by the time of creation. When used, you must specify |
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.