RAIDR/API Reference/Planning

Route over mesh

posthttp://127.0.0.1:8787/api/v1/mesh/route

Finds the best path between two nodes over the deployment graph with Dijkstra. When a target rate is set, edges below it are excluded; if no path meets the target, a best-effort path is returned with meets_target: false.

Request

application/json

This endpoint expects an object.

src_node_idstring <uuid>Required
dst_node_idstring <uuid>Required
metricstringOptional

ett expected transmission time, etx expected transmissions, bottleneck widest path, hops fewest hops.

Defaults to "ett"
Allowedettetxbottleneckhops
target_data_rate_bpsintegerOptional

Exclude edges below this rate.

Response

200 · application/json

Route. Returns an object.

meets_targetbooleanOptional

False when only a best-effort path exists.

Errors

400
Problem

Malformed request.

404
Problem

Resource not found.