STstarlink
Flights

Post a flight event

Required permission: Aviation flight status management, Edit.<br/>Post a real-time flight event on a Starlink-enabled plane. This endpoint is only accessible from an aviation account.

post/public/v2/flights/status

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/flights/status
  • Auth
    HTTP bearer

Request body

tailNumberstring required

Tail Number that matches aircraft registration.

flightNumberstring required

Flight Number that specifies specific route operated by airlines. Please include 2-character airline code in IATA format followed by 1-4 digits.

eventType'EventUnknown' | 'Departure' | 'Arrival' | 'MetadataUpdate' required
eventTimeUtcstring date-time nullable

ISO 8601 Timestamp that represents actual gate departure (if eventType = Departure) or gate arrival (if eventType = Arrival) time in UTC.

estimatedGateArrivalTimeUtcstring date-time nullable

Optional Metadata. ISO 8601 Timestamp that represents estimated gate arrival time in UTC.

passengerCountinteger nullable

Optional Metadata. Actual passenger count on flight.

slaOptOutFlightboolean

Optional Metadata. Exclude this flight from Starlink SLA commitments. Default is false.

Response

OK

informationstring[] nullable
isValidboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.