For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
<Info icon="fa-light fa-lock" className="permission-callout">
<div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>
`Endpoint.FlowLogs.Detail` + `List`
<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div>
</Info>
Returns individual (non-aggregated) Flow Log rows for a device, with pagination, filtering, and sorting.
Each row includes information such as `destination_ip`, `destination_port`, `protocol`, `bytes_up`, and `bytes_down`, and, when available, the `destination_hostname`, `pdp_context`, country, and network.
By default, the response covers the last hour.
Use `started_from` in the `q` parameter to look back up to **30 days**.
Filters follow the standard `q=<field>:<criteria>` syntax:
- Combine multiple filters on different fields with `,` (AND).
- Combine multiple values for the same field with `||` (OR).
Use `sort` to order the results and `page` / `per_page` to paginate.
Authentication
AuthorizationBearer
An auth_token should be provided to authenticate a session.
Sorts detail rows by field value.
Use `<operator><field>` format.
Operators: `-` descending, `+` ascending.
<Tip>
You can also combine multiple sort fields with commas (for example, `-started_on,destination_hostname`).
</Tip>
Filters detail rows by field value.
Use `<field>:<criteria>` format.
Combine multiple filters with commas (for example, `protocol:TCP,destination_hostname:api.example.com`).
Use `||` within one field for multiple values (for example, `protocol:TCP||UDP`).
Supported keys: `destination_hostname`, `destination_ip`, `destination_port`, `protocol`, `flow_id`, `event_type`.
Time window (optional, each as `<field>:<ISO-8601 UTC>`):
- `started_from` - Lower bound on flow start
- Defaults to 1 hour ago
- Maximum look-back 30 days.
- `started_until` - Upper bound on flow start
- Defaults to now.
- `completed_from` / `completed_until` - Bounds on flow completion time.
<Warning>
Window fields must use `:` only (no other operators).
</Warning>
Response headers
X-SortstringOptional
Applied sort field from the sort parameter.
X-FilterstringOptional
Applied filter criteria from the q parameter.
x-current-pageintegerOptional
Current page number.
x-count-per-pageintegerOptional
Number of detail rows per page.
x-total-pagesintegerOptional
Total number of pages.
x-total-countintegerOptional
Total number of detail rows matching the query.
Response
Detail rows for the requested filter window.
flow_idstringOptional
Unique identifier of the flow.
organisation_idintegerOptional
Identifier of the organization that owns the endpoint.
endpoint_idintegerOptional
Identifier of the endpoint the flow belongs to.
started_onstringOptionalformat: "date-time"
Start time of the flow.
completed_onstringOptionalformat: "date-time"
Completion time of the flow.
duration_secondsintegerOptional
Duration of the flow in seconds.
event_typestringOptional
Type of flow event (for example, flow_start, flow_update).
directionstringOptional
Direction of the flow (for example, ingress, egress).
source_ipstringOptional
Source IP address of the flow.
source_portintegerOptional
Source port of the flow.
destination_ipstringOptional
IP address of the destination.
destination_portintegerOptional
Destination port number.
protocolstringOptional
Transport protocol (for example, TCP, UDP).
bytes_upintegerOptional
Total bytes uploaded to the destination.
bytes_downintegerOptional
Total bytes downloaded from the destination.
destination_hostnamestring or nullOptional
Hostname of the destination, if resolved.
destination_hostname_sourcestring or nullOptional
Source used to resolve the destination hostname (for example, TLS_SNI, reverse_dns).
nat_detailsobject or nullOptional
Network address translation details, if available.
pdp_contextobject or nullOptional
PDP context information for the flow, if available.
release_detailsobject or nullOptional
Details about how the flow was released, if available.
session_idstringOptional
Identifier of the PDP session the flow belongs to.
Returns individual (non-aggregated) Flow Log rows for a device, with pagination, filtering, and sorting.
Each row includes information such as destination_ip, destination_port, protocol, bytes_up, and bytes_down, and, when available, the destination_hostname, pdp_context, country, and network.
By default, the response covers the last hour.
Use started_from in the q parameter to look back up to 30 days.
Filters follow the standard q=<field>:<criteria> syntax:
Combine multiple filters on different fields with , (AND).
Combine multiple values for the same field with || (OR).
Use sort to order the results and page / per_page to paginate.
Sorts detail rows by field value.
Use <operator><field> format.
Operators: - descending, + ascending.
You can also combine multiple sort fields with commas (for example, -started_on,destination_hostname).
Filters detail rows by field value.
Use <field>:<criteria> format.
Combine multiple filters with commas (for example, protocol:TCP,destination_hostname:api.example.com).
Use || within one field for multiple values (for example, protocol:TCP||UDP).