Flights

Get Flight

Get details of a specific Flight, including error messages when available. This is especially important for applications that need to diagnose failed or cancelled Flights.

get/nests/{nestId}/birds/{birdId}/flights/{flightId}

Request

  • Base URL: https://eu-1.blackbird.io/api-rest
  • URL: https://eu-1.blackbird.io/api-rest/nests/{nestId}/birds/{birdId}/flights/{flightId}
  • Auth: API key in header Authorization

Path parameters

nestIdstring required

The ID of the Nest that contains the Bird.

birdIdstring required

The ID of the Bird whose Flight is being retrieved.

flightIdstring required

The ID of the Flight.

Response

The requested Flight.

idstring
birdIdstring
nestIdstring
status'succeeded' | 'failed' | 'cancelled' | 'active'
errorMessagesstring nullable

Error details for the Flight when available. This field is especially useful for applications that need to diagnose failed or cancelled Flights.

startDatestring date-time
durationinteger

Changes

No recorded changes to this operation across all 1 revision of this API.