mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-25 03:46:35 +00:00
Update API pages with v0.43.1
This commit is contained in:
netbirddev
@@ -216,7 +216,47 @@ echo $response;
|
|||||||
<Row>
|
<Row>
|
||||||
<Col>
|
<Col>
|
||||||
Returns a list of all network traffic events
|
Returns a list of all network traffic events
|
||||||
</Col>
|
|
||||||
|
### Query Parameters
|
||||||
|
<Properties>
|
||||||
|
|
||||||
|
<Property name="page" type="integer" required={false}>
|
||||||
|
Page number
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="page_size" type="integer" required={false}>
|
||||||
|
Number of items per page
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="user_id" type="string" required={false}>
|
||||||
|
Filter by user ID
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="protocol" type="integer" required={false}>
|
||||||
|
Filter by protocol
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="type" type="string" required={false}>
|
||||||
|
Filter by event type
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="direction" type="string" required={false}>
|
||||||
|
Filter by direction
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="search" type="string" required={false}>
|
||||||
|
Filters events with a partial match on user email, source and destination names and source and destination addresses
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="start_date" type="string" required={false}>
|
||||||
|
Start date for filtering events (ISO 8601 format, e.g., 2024-01-01T00:00:00Z).
|
||||||
|
</Property>
|
||||||
|
|
||||||
|
<Property name="end_date" type="string" required={false}>
|
||||||
|
End date for filtering events (ISO 8601 format, e.g., 2024-01-31T23:59:59Z).
|
||||||
|
</Property>
|
||||||
|
</Properties>
|
||||||
|
</Col>
|
||||||
|
|
||||||
<Col sticky>
|
<Col sticky>
|
||||||
<CodeGroup title="Request" tag="GET" label="/api/events/network-traffic">
|
<CodeGroup title="Request" tag="GET" label="/api/events/network-traffic">
|
||||||
@@ -369,102 +409,126 @@ echo $response;
|
|||||||
|
|
||||||
<CodeGroup title="Response">
|
<CodeGroup title="Response">
|
||||||
```json {{ title: 'Example' }}
|
```json {{ title: 'Example' }}
|
||||||
[
|
{
|
||||||
{
|
"data": [
|
||||||
"id": "18e204d6-f7c6-405d-8025-70becb216add",
|
{
|
||||||
"flow_id": "61092452-b17c-4b14-b7cf-a2158c549826",
|
"id": "18e204d6-f7c6-405d-8025-70becb216add",
|
||||||
"reporter_id": "ch8i4ug6lnn4g9hqv7m0",
|
"flow_id": "61092452-b17c-4b14-b7cf-a2158c549826",
|
||||||
"timestamp": "2025-03-20T16:23:58.125397Z",
|
"reporter_id": "ch8i4ug6lnn4g9hqv7m0",
|
||||||
"receive_timestamp": "2025-03-20T16:23:58.125397Z",
|
"timestamp": "2025-03-20T16:23:58.125397Z",
|
||||||
"source": {
|
"receive_timestamp": "2025-03-20T16:23:58.125397Z",
|
||||||
"id": "ch8i4ug6lnn4g9hqv7m0",
|
"source": {
|
||||||
"type": "PEER",
|
"id": "ch8i4ug6lnn4g9hqv7m0",
|
||||||
"name": "My Peer",
|
"type": "PEER",
|
||||||
"geo_location": {
|
"name": "My Peer",
|
||||||
"city_name": "Berlin",
|
"geo_location": {
|
||||||
"country_code": "DE"
|
"city_name": "Berlin",
|
||||||
|
"country_code": "DE"
|
||||||
|
},
|
||||||
|
"os": "Linux",
|
||||||
|
"address": "100.64.0.10:51820",
|
||||||
|
"dns_label": "*.mydomain.com"
|
||||||
},
|
},
|
||||||
"os": "Linux",
|
"user_id": "google-oauth2|123456789012345678901",
|
||||||
"address": "100.64.0.10:51820",
|
"user_email": "alice@netbird.io",
|
||||||
"dns_label": "*.mydomain.com"
|
"user_name": "Alice Smith",
|
||||||
},
|
"destination": {
|
||||||
"user_id": "google-oauth2|123456789012345678901",
|
"id": "ch8i4ug6lnn4g9hqv7m0",
|
||||||
"user_email": "alice@netbird.io",
|
"type": "PEER",
|
||||||
"user_name": "Alice Smith",
|
"name": "My Peer",
|
||||||
"destination": {
|
"geo_location": {
|
||||||
"id": "ch8i4ug6lnn4g9hqv7m0",
|
"city_name": "Berlin",
|
||||||
"type": "PEER",
|
"country_code": "DE"
|
||||||
"name": "My Peer",
|
},
|
||||||
"geo_location": {
|
"os": "Linux",
|
||||||
"city_name": "Berlin",
|
"address": "100.64.0.10:51820",
|
||||||
"country_code": "DE"
|
"dns_label": "*.mydomain.com"
|
||||||
},
|
},
|
||||||
"os": "Linux",
|
"protocol": 6,
|
||||||
"address": "100.64.0.10:51820",
|
"type": "TYPE_START",
|
||||||
"dns_label": "*.mydomain.com"
|
"direction": "INGRESS",
|
||||||
},
|
"rx_bytes": 1234,
|
||||||
"protocol": 6,
|
"rx_packets": 5,
|
||||||
"type": "TYPE_START",
|
"tx_bytes": 1234,
|
||||||
"direction": "INGRESS",
|
"tx_packets": 5,
|
||||||
"rx_bytes": 1234,
|
"policy_id": "ch8i4ug6lnn4g9hqv7m0",
|
||||||
"rx_packets": 5,
|
"policy_name": "All to All",
|
||||||
"tx_bytes": 1234,
|
"icmp_type": 8,
|
||||||
"tx_packets": 5,
|
"icmp_code": 0
|
||||||
"policy_id": "ch8i4ug6lnn4g9hqv7m0",
|
}
|
||||||
"policy_name": "All to All",
|
],
|
||||||
"icmp_type": 8,
|
"page": {
|
||||||
"icmp_code": 0
|
"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"
|
||||||
}
|
}
|
||||||
]
|
}
|
||||||
```
|
```
|
||||||
```json {{ title: 'Schema' }}
|
```json {{ title: 'Schema' }}
|
||||||
[
|
{
|
||||||
{
|
"data": [
|
||||||
"id": "string",
|
{
|
||||||
"flow_id": "string",
|
|
||||||
"reporter_id": "string",
|
|
||||||
"timestamp": "string",
|
|
||||||
"receive_timestamp": "string",
|
|
||||||
"source": {
|
|
||||||
"id": "string",
|
"id": "string",
|
||||||
"type": "string",
|
"flow_id": "string",
|
||||||
"name": "string",
|
"reporter_id": "string",
|
||||||
"geo_location": {
|
"timestamp": "string",
|
||||||
"city_name": "string",
|
"receive_timestamp": "string",
|
||||||
"country_code": "string"
|
"source": {
|
||||||
|
"id": "string",
|
||||||
|
"type": "string",
|
||||||
|
"name": "string",
|
||||||
|
"geo_location": {
|
||||||
|
"city_name": "string",
|
||||||
|
"country_code": "string"
|
||||||
|
},
|
||||||
|
"os": "string",
|
||||||
|
"address": "string",
|
||||||
|
"dns_label": "string"
|
||||||
},
|
},
|
||||||
"os": "string",
|
"user_id": "string",
|
||||||
"address": "string",
|
"user_email": "string",
|
||||||
"dns_label": "string"
|
"user_name": "string",
|
||||||
},
|
"destination": {
|
||||||
"user_id": "string",
|
"id": "string",
|
||||||
"user_email": "string",
|
"type": "string",
|
||||||
"user_name": "string",
|
"name": "string",
|
||||||
"destination": {
|
"geo_location": {
|
||||||
"id": "string",
|
"city_name": "string",
|
||||||
"type": "string",
|
"country_code": "string"
|
||||||
"name": "string",
|
},
|
||||||
"geo_location": {
|
"os": "string",
|
||||||
"city_name": "string",
|
"address": "string",
|
||||||
"country_code": "string"
|
"dns_label": "string"
|
||||||
},
|
},
|
||||||
"os": "string",
|
"protocol": "integer",
|
||||||
"address": "string",
|
"type": "string",
|
||||||
"dns_label": "string"
|
"direction": "string",
|
||||||
},
|
"rx_bytes": "integer",
|
||||||
"protocol": "integer",
|
"rx_packets": "integer",
|
||||||
"type": "string",
|
"tx_bytes": "integer",
|
||||||
"direction": "string",
|
"tx_packets": "integer",
|
||||||
"rx_bytes": "integer",
|
"policy_id": "string",
|
||||||
"rx_packets": "integer",
|
"policy_name": "string",
|
||||||
"tx_bytes": "integer",
|
"icmp_type": "integer",
|
||||||
"tx_packets": "integer",
|
"icmp_code": "integer"
|
||||||
"policy_id": "string",
|
}
|
||||||
"policy_name": "string",
|
],
|
||||||
"icmp_type": "integer",
|
"page": "integer",
|
||||||
"icmp_code": "integer"
|
"page_size": "integer",
|
||||||
}
|
"total_records": "integer",
|
||||||
]
|
"total_pages": "integer"
|
||||||
|
}
|
||||||
```
|
```
|
||||||
</CodeGroup>
|
</CodeGroup>
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user