Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The pilot's API key, obtained via POST /pilot/login or your OAuth flow. Send as Authorization: Bearer <api_key> on every authenticated request.

Body

application/json
phase
enum<string>
required

Current flight phase as Stratos sends it, in capitals. TAXI_IN and ARRIVED are both sent as TAXI_TO_GATE, PAUSED is sent while the simulator is paused, and UNKNOWN before a phase is detected. The reference implementation reads the value case-insensitively and treats anything it doesn't know as CRUISE (PirepStatus::ENROUTE).

Available options:
BOARDING,
PUSH_BACK,
TAXI,
TAKE_OFF,
REJECTED_TAKE_OFF,
CLIMB,
CRUISE,
DESCENT,
APPROACH,
FINAL,
LANDED,
GO_AROUND,
TAXI_TO_GATE,
DEBOARDING,
PAUSED,
UNKNOWN
latitude
number<double>
required
Required range: -90 <= x <= 90
longitude
number<double>
required
Required range: -180 <= x <= 180
altitude
number
required

Indicated altitude in feet.

heading
number<float>
required

True heading in degrees.

Required range: 0 <= x <= 360
uuid
string<uuid>

PIREP ID returned by /flights/start. Use either this or tracking_id.

tracking_id
string<uuid>

Synonym for uuid, supplied for backwards compatibility.

ground_speed
number<float>

Ground speed in knots. Defaults to 0 if omitted.

distance_remaining
number<float>

Nautical miles remaining to destination. Used to compute the cumulative distance written to the FLIGHT_PATH row.

Response

object | null

Update accepted. The reference implementation returns an empty body.

The response is of type object | null.