İçeriğe geç
Updraft Docs
English

Gizlilik maskeleri · API referansı

Pilotun kendi uygulamasının kurduğu ev ve özel maskeler: içlerindeki fix'ler bütün paylaşılan katmanlardan çıkar.

GET /v1/privacy-masks

The privacy masks of a pilot

The pilot's masks with their geometry, oldest first; an unknown pilot has none. The pilot is named in the X-Pilot-Hash header, not in the address.

Kimlik: X-Api-Key başlığı; gereken kapsam: kapsam tablosu.

Parametreler

AdYerTipAçıklama
X-Pilot-Hash zorunlubaşlıkstringHMAC-SHA256 of the client's pilot id, 64 hex characters; the same value as external_pilot_hash of the uploads
^[0-9a-fA-F]{64}$

Yanıtlar

DurumAçıklamaİçerik
200Successful Responseapplication/json → PilotMaskList
401code: auth_missing, auth_invalid, auth_revokedapplication/json → ErrorBody
403code: auth_scopeapplication/json → ErrorBody
422code: request_invalidapplication/json → ErrorBody
429code: rate_limited, quota_exceeded (Retry-After seconds)
Başlıklar: Retry-After — Seconds until the exhausted window resets
application/json → ErrorBody

POST /v1/privacy-masks

Add a home or custom privacy mask for a pilot

The pilot's fixes inside the mask leave every shared layer: within minutes the pilot's flights are processed again with it, within 24 hours every published grid cell, thermal, take-off/landing and skyway count is recomputed without them. The public replay of a shared flight hides the area at once. An unknown pilot is created, so a mask set before the first upload covers it.

Kimlik: X-Api-Key başlığı; gereken kapsam: kapsam tablosu.

İstek gövdesi

application/json → PilotMaskCreate

Yanıtlar

DurumAçıklamaİçerik
201Successful Responseapplication/json → PilotMaskReceipt
401code: auth_missing, auth_invalid, auth_revokedapplication/json → ErrorBody
403code: auth_scopeapplication/json → ErrorBody
409code: home_mask_exists, mask_limitapplication/json → ErrorBody
422code: mask_invalid, request_invalidapplication/json → ErrorBody
429code: rate_limited, quota_exceeded (Retry-After seconds)
Başlıklar: Retry-After — Seconds until the exhausted window resets
application/json → ErrorBody

DELETE /v1/privacy-masks/{mask_id}

Remove a privacy mask of a pilot

The pilot's flights are processed again without the mask; its fixes may then count in the shared layers again (threshold rules unchanged).

Kimlik: X-Api-Key başlığı; gereken kapsam: kapsam tablosu.

Parametreler

AdYerTipAçıklama
mask_id zorunluyolstring (uuid)id of the mask
X-Pilot-Hash zorunlubaşlıkstringHMAC-SHA256 of the client's pilot id, 64 hex characters; the same value as external_pilot_hash of the uploads
^[0-9a-fA-F]{64}$

Yanıtlar

DurumAçıklamaİçerik
200Successful Responseapplication/json → PilotMaskReceipt
401code: auth_missing, auth_invalid, auth_revokedapplication/json → ErrorBody
403code: auth_scopeapplication/json → ErrorBody
404code: mask_not_foundapplication/json → ErrorBody
422code: request_invalidapplication/json → ErrorBody
429code: rate_limited, quota_exceeded (Retry-After seconds)
Başlıklar: Retry-After — Seconds until the exhausted window resets
application/json → ErrorBody