Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Data Learning Engine RESTful API Quick Reference

 

Table 1 lists the DLE RESTful APIs available to access and manage DLE capabilities.

Table 1: Data Learning Engine RESTful API Quick-Reference

DLE Capability

RESTful APIs Available

Description

Managing Compute Agent and DLE Server Information

GET /api/v1/events

Request to subscribe to DLE Server-Sent Events (SSE) text-based streamed event data, to learn about Compute Agents DLE has discovered.

GET /api/v1/compute-agents

Retrieve information about Compute Agents known to DLE, to learn about the application flows available to be traced.

Managing DLE Flow Path Traces

POST /api/v1/traces

Start an application flow path trace (non-overlay) or tunnel flow trace (overlay).

PUT /api/v1/traces/{traceId}

Stop an active flow path trace.

GET /api/v1/traces

Retrieve trace data for flow path traces managed by DLE, either all available traces or filter results based on trace status.

GET /api/v1/traces/{traceId}

Retrieve detailed flow path trace data for a particular trace ID.

GET /api/v1/traces/{traceId}/probes [?additionalInfo=hops]

Retrieve summary data from probes in a DLE flow path trace, including per-hop summary information if desired.

GET /api/v1/traces/{traceId}/probes/{probeId}

Retrieve detailed probe and hops data for a particular probe in a DLE flow path trace.

GET /api/v1/traces/{traceId}/interface-stats

Retrieve detailed device interface packet transfer statistics from a DLE flow path trace.

Managing DLE Data Subscriptions

POST /api/v1/subscription/subscribeAll

Subscribe to receive streaming bulk flow path analytics data for all flows known to DLE.

DELETE /api/v1/subscription/unsubscribe

Unsubscribe from DLE bulk flow path analytics data subscription service.

Retrieving Network Traffic Analysis Statistics

GET /api/v1/nta/top-applications

Return NTA top conversation statistics collected by DLE for a network device.

GET /api/v1/nta/top-conversations

Return NTA top conversation statistics collected by DLE for a network device.

GET /api/v1/nta/application-stats

Return NTA application samples statistics collected by DLE for a network device.

GET /api/v1/nta/conversation-stats

Return NTA conversation samples statistics collected by DLE for a network device.