Get audit logs for team

GET /v1/team/audit_log

Try it

Get audit logs for team

cURL

curl --request GET \
  --url https://api.projectdiscovery.io/v1/team/audit_log \
  --header 'X-API-Key: <api-key>'

200

{
  "message": "<string>",
  "data": [
    {
      "created_at": "<string>",
      "email": "<string>",
      "action": "<string>",
      "status": 123,
      "method": "<string>",
      "ip": "<string>",
      "path": "<string>"
    }
  ]
}

Filtering Audit Logs

This endpoint supports multiple filter parameters to help you narrow down audit log entries:

Date Filters

• start_date and end_date: Filter logs by custom date range
• time_range: Use predefined time ranges for quick filtering
  • current_month - Logs from the current month
  • last_month - Logs from the previous month
  • last_3_months - Logs from the last 3 months
  • last_6_months - Logs from the last 6 months
  • last_12_months - Logs from the last 12 months

Additional Filters

• email: Filter by specific user email
• action: Filter by specific action name (e.g., endpoint path)
• source: Filter by the source of the audit log entry
  • api - Actions performed via API
  • platform - Actions performed via the web platform
  • unknown - Actions from unknown sources

Pagination

• limit: Number of rows to return (default: 100, max: 100)
• offset: Number of rows to skip for pagination

Example Usage

Filter logs from the last month for a specific user:

curl -X GET "https://api.projectdiscovery.io/v1/team/audit_log?time_range=last_month&email=[e-mail]" \
  -H "X-Api-Key: YOUR_API_KEY"

Filter logs by source and date range:

curl -X GET "https://api.projectdiscovery.io/v1/team/audit_log?source=api&start_date=2024-01-01&end_date=2024-01-31" \
  -H "X-Api-Key: YOUR_API_KEY"

Authorizations

X-API-Key · string · header · required

Headers

X-Team-Id · string

Retrieve the Team ID from: https://cloud.projectdiscovery.io/settings/team

Query Parameters

email · string

filter by specific user

action · string

filter by specific action name

offset · integer

number of rows to skip

limit · integer

number of rows to get

start_date · string<date>

start date from which you want to get logs

end_date · string<date>

end date till which you want to get logs

time_range · enum<string>

time range to get logs

Available options: current_month, last_month, last_3_months, last_6_months, last_12_months

source · enum<string>

filter by source of the audit log entry

Available options: api, platform, unknown

Response

200

application/json

OK

message · string · required

data · UserAuditLogItems · object[] · required

Show child attributes

data. created_at · string · required

data. email · string · required

data. action · string · required

data. status · integer · required

data. method · string · required

data. ip · string · required

data. path · string · required