Ingress

Capture ports, their statistics and the capture card configuration

The ingress is the capture card of the device. These endpoints list the capture ports with their link state, report and reset the capture statistics, and configure the card: port speed, time synchronisation, PTP, PPS and inline mode. What the card supports is reported by the Capabilities endpoint.

Ports

Endpoint	Method and path
List all ports	`GET /api/ftng/ingress/ports`
Get one port	`GET /api/ftng/ingress/ports/{port_id}`

Statistics

Endpoint	Method and path
Statistics of all ports	`GET /api/ftng/ingress/statistics/ports`
Statistics of one port	`GET /api/ftng/ingress/statistics/ports/{port_id}`
Global statistics	`GET /api/ftng/ingress/statistics/global`
Reset statistics of one port	`DELETE /api/ftng/ingress/statistics/ports/{port_id}`
Reset global statistics	`DELETE /api/ftng/ingress/statistics/global`

Capture card configuration

Endpoint	Method and path
Get the configuration	`GET /api/ftng/ingress/config`
Update the configuration	`PUT /api/ftng/ingress/config`
Get the applied state	`GET /api/ftng/ingress/state`

Common properties
- Minimum user role: viewer for GET, operator for PUT and DELETE
- Responses use the standard {"message": ..., "data": ...} envelope; the linked pages show the content of data
- Response on failure (500 Internal Server Error): {"message": "Failed to redirect request: <reason>", "data": null} when the traffic analysis service cannot be reached

Back to Index