mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-25 20:06:35 +00:00
Update API pages with v0.43.1
This commit is contained in:
@@ -216,6 +216,46 @@ echo $response;
|
|||||||
<Row>
|
<Row>
|
||||||
<Col>
|
<Col>
|
||||||
Returns a list of all network traffic events
|
Returns a list of all network traffic events
|
||||||
|
|
||||||
|
### 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>
|
||||||
|
|
||||||
<Col sticky>
|
<Col sticky>
|
||||||
@@ -369,7 +409,8 @@ echo $response;
|
|||||||
|
|
||||||
<CodeGroup title="Response">
|
<CodeGroup title="Response">
|
||||||
```json {{ title: 'Example' }}
|
```json {{ title: 'Example' }}
|
||||||
[
|
{
|
||||||
|
"data": [
|
||||||
{
|
{
|
||||||
"id": "18e204d6-f7c6-405d-8025-70becb216add",
|
"id": "18e204d6-f7c6-405d-8025-70becb216add",
|
||||||
"flow_id": "61092452-b17c-4b14-b7cf-a2158c549826",
|
"flow_id": "61092452-b17c-4b14-b7cf-a2158c549826",
|
||||||
@@ -415,10 +456,28 @@ echo $response;
|
|||||||
"icmp_type": 8,
|
"icmp_type": 8,
|
||||||
"icmp_code": 0
|
"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"
|
||||||
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
```json {{ title: 'Schema' }}
|
```json {{ title: 'Schema' }}
|
||||||
[
|
{
|
||||||
|
"data": [
|
||||||
{
|
{
|
||||||
"id": "string",
|
"id": "string",
|
||||||
"flow_id": "string",
|
"flow_id": "string",
|
||||||
@@ -464,7 +523,12 @@ echo $response;
|
|||||||
"icmp_type": "integer",
|
"icmp_type": "integer",
|
||||||
"icmp_code": "integer"
|
"icmp_code": "integer"
|
||||||
}
|
}
|
||||||
]
|
],
|
||||||
|
"page": "integer",
|
||||||
|
"page_size": "integer",
|
||||||
|
"total_records": "integer",
|
||||||
|
"total_pages": "integer"
|
||||||
|
}
|
||||||
```
|
```
|
||||||
</CodeGroup>
|
</CodeGroup>
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user