RAIDR/API Reference/Coverage

Start coverage job

posthttp://127.0.0.1:8787/api/v1/coverage

Starts an asynchronous coverage job. The server builds a square grid centred on the source and evaluates a full link to a receiver at each cell. Subscribe to the job's event stream for live progress.

Request

application/json

This endpoint expects an object.

source_node_idstring <uuid>Required
radius_kmnumberRequired

Clamped to (0, 500].

0 to 500
resolutionintegerOptional

Grid cells per side. Clamped to the range.

4 to 256
rx_height_agl_mnumberOptional

Receiver height above ground.

Response

200 · application/json

Job started. Returns an object.

job_idstring <uuid>Required

Errors

400
Problem

Malformed request.

404
Problem

Resource not found.