A valid request URL is required to generate request examples{
"tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmation": "<string>",
"can_override": true
}{
"success": false,
"error": "Invalid Token"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}Begin tracking a booked flight
Prefiles a PIREP for the chosen bid and returns a tracking_id (the new PIREP’s UUID) that subsequent /flights/update and /flights/complete calls reference.
If bid_id is omitted, the phpVMS reference implementation falls back to the pilot’s most recent bid. This exists for older client builds that send an empty body. New integrations should always send bid_id.
Aircraft selection priority on the server:
- SimBrief-attached aircraft (if the pilot has a SimBrief OFP for this flight)
- The bid’s
aircraft_id(if the bid was made against a specific airframe) - The first available aircraft from the flight’s subfleets
If none can be resolved, the server returns 500 with "No aircraft attached to bid".
A valid request URL is required to generate request examples{
"tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmation": "<string>",
"can_override": true
}{
"success": false,
"error": "Invalid Token"
}{
"error": "<string>",
"success": true,
"message": "<string>"
}Authorizations
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
Bid to start flying. Omit to fall back to the pilot's most recent bid (legacy behaviour).
Response
PIREP prefiled. Use tracking_id on subsequent flight calls.
PIREP UUID. Send this back as uuid or tracking_id on /flights/update, /flights/complete, and /flights/cancel.
Optional message shown to the pilot in a confirmation dialog before tracking starts (e.g. flagging a simulator setup mismatch). When present, the client blocks the start until the pilot either acknowledges via "Start tracking anyway" (subject to override permission) or re-validates and retries.
Optional per-start override flag, only meaningful alongside confirmation. Takes priority over the airline's Allow Start Override setting for the confirmation dialog: true always lets the pilot "Start tracking anyway"; false always disables the button. Omit to fall back to the airline setting.
Was this page helpful?