flowLogs

Retrieve Flow Logs by destination

<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.Destination + List

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info>

Retrieves Flow Log activity for an endpoint, grouped by destination hostname, IP address, port, and protocol.

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.

get/api/v1/endpoint/{endpointId}/flowlogs/destination

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpointId}/flowlogs/destination
  • Auth: HTTP bearer

Path parameters

endpointIdnumber double required

Query parameters

per_pageinteger

Number of destination groups to return per page.

pageinteger

Page number to retrieve. Starts at 1.

sortstring

Sorts destination groups 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>
qstring

Filters destination groups 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).

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

Destination groups for the requested window.

destination_hostnamestring nullable

Hostname of the destination, if resolved.

destination_ipstring

IP address of the destination.

destination_portinteger

Destination port number.

protocolstring

Transport protocol (for example, TCP, UDP).

started_onstring date-time

Earliest start time across the aggregated flows.

completed_onstring date-time

Latest completion time across the aggregated flows.

bytes_upinteger

Total bytes uploaded to the destination.

bytes_downinteger

Total bytes downloaded from the destination.

flow_countinteger

Number of flows aggregated into this destination group.

Changes

No recorded changes to this operation across all 1 revision of this API.