couchdrop-api
Search
⌃K

Auditing and Reporting

Couchdrop has comprehensive auditing across all operations. Audit events can be pulled from the API
post
https://api.couchdrop.io
/manage/files
Get audit events
Parameters
Query
page
Number
Page number
pagesize
Number
Required page size
Header
token*
API token
Body
transfers
Boolean
Example filter. See filters below for more details of available filters
Responses
200: OK

Complex Filters

The API allows you to filter and search for specific events and event types. Filters are supplied as POST body params in JSON.
Filter Param
Description
Example value
transfers
Include UPLOAD and DOWNLOAD events
true
authentication
Include authentication events.
true
malware
Include malware events
true
admin
Include admin and management events
true
filesystem
Include filesystem events like LS/LSTAT/RENAME
true
workflow
Include workflow events
true
authenticated_user
Filter events to a specific user
"user1"
transaction_id
Filter events to a specific transaction id
"<uuid>"
filename
Filter events to a specific filename
"example.txt"
search
Wildcard search on the filename and message field
"downloaded file"
workflow_id
Filter events to those to those generated by a specific workflow/automation
"<uuid>"

Specifying a time frame filter

You can restrict results to a specific time period, this can be done using relative or absolute time. Time filtering is sent to the API in the same way as the Complex Filters above.
Filter param
Description
Example
date
Filter type
Accepted values:
  • hour
  • 2hours
  • day
  • week
  • month
  • custom
custom_start_date
When "date" is set to "custom" this is required. A unix timestamp is required
1674767806
custom_end_date
End date for above
1674769100