Skip to content
Updraft Docs
Türkçe

Sharing · API reference

Opening and closing the public replay link of a flight.

POST /v1/flights/{flight_id}/shares

Share a flight: open (or return) its public replay link

201 with a new link, or 200 with the active one when the flight is already shared (repeating the request is safe). The link works until the pilot stops sharing or the flight is deleted; sharing again after that gives a new link.

Authentication: X-Api-Key header; required scope: scope table.

Parameters

NameInTypeDescription
flight_id requiredpathstring (uuid)Updraft flight id (flight_id of the upload response)

Request body

application/json → ShareRequestBody

Responses

StatusDescriptionContent
200The flight was already shared: same linkapplication/json → ShareOut
201Successful Responseapplication/json → ShareOut
401code: auth_missing, auth_invalid, auth_revokedapplication/json → ErrorBody
403code: auth_scopeapplication/json → ErrorBody
404code: flight_not_foundapplication/json → ErrorBody
409code: flight_deletedapplication/json → ErrorBody
422code: request_invalidapplication/json → ErrorBody
429code: rate_limited, quota_exceeded (Retry-After seconds)
Headers: Retry-After — Seconds until the exhausted window resets
application/json → ErrorBody

DELETE /v1/flights/{flight_id}/shares

Stop sharing a flight: its public link is gone at once

The link answers 404 from now on (public caches drop it within the replay's max-age, §12). 204 also when nothing was shared (repeating the request is safe).

Authentication: X-Api-Key header; required scope: scope table.

Parameters

NameInTypeDescription
flight_id requiredpathstring (uuid)Updraft flight id (flight_id of the upload response)

Request body

application/json → ShareRequestBody

Responses

StatusDescriptionContent
204Successful Response
401code: auth_missing, auth_invalid, auth_revokedapplication/json → ErrorBody
403code: auth_scopeapplication/json → ErrorBody
404code: flight_not_foundapplication/json → ErrorBody
422code: request_invalidapplication/json → ErrorBody
429code: rate_limited, quota_exceeded (Retry-After seconds)
Headers: Retry-After — Seconds until the exhausted window resets
application/json → ErrorBody