GET/api/events/audit
List all Audit Events
Returns a list of all audit events
Request
GET
/api/events/auditcurl -X GET https://api.netbird.io/api/events/audit \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Response
[
{
"id": 10,
"timestamp": "2023-05-05T10:04:37.473542Z",
"activity": "Route created",
"activity_code": "route.add",
"initiator_id": "google-oauth2|123456789012345678901",
"initiator_name": "John Doe",
"initiator_email": "demo@netbird.io",
"target_id": "chad9d86lnnc59g18ou0",
"meta": {
"name": "my route",
"network_range": "10.64.0.0/24",
"peer_id": "chacbco6lnnbn6cg5s91"
}
}
]
GET/api/events/network-traffic
List all Traffic Events cloud-only experimental
Returns a list of all network traffic events
Query Parameters
- Name
page
- Type
- integer
- Required
- optional
- Enum
- Description
Page number
- Name
page_size
- Type
- integer
- Required
- optional
- Enum
- Description
Number of items per page
- Name
user_id
- Type
- string
- Required
- optional
- Enum
- Description
Filter by user ID
- Name
protocol
- Type
- integer
- Required
- optional
- Enum
- Description
Filter by protocol
- Name
type
- Type
- string
- Required
- optional
- Enum
- Description
Filter by event type
- Name
connection_type
- Type
- string
- Required
- optional
- Enum
- Description
Filter by connection type
- Name
direction
- Type
- string
- Required
- optional
- Enum
- Description
Filter by direction
- Name
search
- Type
- string
- Required
- optional
- Enum
- Description
Filters events with a partial match on user email, source and destination names and source and destination addresses
- Name
start_date
- Type
- string
- Required
- optional
- Enum
- Description
Start date for filtering events (ISO 8601 format, e.g., 2024-01-01T00:00:00Z).
- Name
end_date
- Type
- string
- Required
- optional
- Enum
- Description
End date for filtering events (ISO 8601 format, e.g., 2024-01-31T23:59:59Z).
Request
GET
/api/events/network-trafficcurl -X GET https://api.netbird.io/api/events/network-traffic \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Response
{
"data": [
{
"id": "18e204d6-f7c6-405d-8025-70becb216add",
"flow_id": "61092452-b17c-4b14-b7cf-a2158c549826",
"reporter_id": "ch8i4ug6lnn4g9hqv7m0",
"timestamp": "2025-03-20T16:23:58.125397Z",
"receive_timestamp": "2025-03-20T16:23:58.125397Z",
"source": {
"id": "ch8i4ug6lnn4g9hqv7m0",
"type": "PEER",
"name": "My Peer",
"geo_location": {
"city_name": "Berlin",
"country_code": "DE"
},
"os": "Linux",
"address": "100.64.0.10:51820",
"dns_label": "*.mydomain.com"
},
"user_id": "google-oauth2|123456789012345678901",
"user_email": "alice@netbird.io",
"user_name": "Alice Smith",
"destination": {
"id": "ch8i4ug6lnn4g9hqv7m0",
"type": "PEER",
"name": "My Peer",
"geo_location": {
"city_name": "Berlin",
"country_code": "DE"
},
"os": "Linux",
"address": "100.64.0.10:51820",
"dns_label": "*.mydomain.com"
},
"protocol": 6,
"type": "TYPE_START",
"direction": "INGRESS",
"rx_bytes": 1234,
"rx_packets": 5,
"tx_bytes": 1234,
"tx_packets": 5,
"policy_id": "ch8i4ug6lnn4g9hqv7m0",
"policy_name": "All to All",
"icmp_type": 8,
"icmp_code": 0
}
],
"page": {
"type": "integer",
"description": "Current page number"
},
"page_size": {
"type": "integer",
"description": "Number of items per page"
},
"total_records": {
"type": "integer",
"description": "Total number of event records available"
},
"total_pages": {
"type": "integer",
"description": "Total number of pages available"
}
}