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
| Name | In | Type | Description |
|---|---|---|---|
flight_id required | path | string (uuid) | Updraft flight id (flight_id of the upload response) |
Request body
application/json → ShareRequestBody
Responses
| Status | Description | Content |
|---|---|---|
200 | The flight was already shared: same link | application/json → ShareOut |
201 | Successful Response | application/json → ShareOut |
401 | code: auth_missing, auth_invalid, auth_revoked | application/json → ErrorBody |
403 | code: auth_scope | application/json → ErrorBody |
404 | code: flight_not_found | application/json → ErrorBody |
409 | code: flight_deleted | application/json → ErrorBody |
422 | code: request_invalid | application/json → ErrorBody |
429 | code: 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
| Name | In | Type | Description |
|---|---|---|---|
flight_id required | path | string (uuid) | Updraft flight id (flight_id of the upload response) |
Request body
application/json → ShareRequestBody
Responses
| Status | Description | Content |
|---|---|---|
204 | Successful Response | |
401 | code: auth_missing, auth_invalid, auth_revoked | application/json → ErrorBody |
403 | code: auth_scope | application/json → ErrorBody |
404 | code: flight_not_found | application/json → ErrorBody |
422 | code: request_invalid | application/json → ErrorBody |
429 | code: rate_limited, quota_exceeded (Retry-After seconds)Headers: Retry-After — Seconds until the exhausted window resets | application/json → ErrorBody |