Obiecte

ApiKeyUpdate

Modificări ale cheii. Câmpurile netransmise rămân neschimbate, iar data_profile este opțional. O listă scopes goală înseamnă domenii după rol, collection_ids și allowed_cidrs goale înseamnă fără restricție, iar expires_at setat la null înseamnă că cheia nu expiră. O cheie care este ea însăși restrânsă la colecții nu poate elimina sau lărgi o restricție la colecții (collection_ids).

Câmpuri

data_profilestring
Profilul de date nou al cheii. Profilul de date nu se aplică rolului admin, așa că pentru o cheie de administrator un profil diferit de full returnează 400 api_keys.data_profile_not_applicable.
scopesarray of ApiKeyScope
Domeniile de acces ale cheii. Domeniul system nu se emite prin API.
collection_idsarray of integer
Restrânge cheia la aceste colecții. O listă goală înseamnă fără restricție. O cheie care face cererea și este ea însăși restrânsă la colecții vede și modifică doar cheile din colecțiile ei (celelalte chei returnează 404 api_keys.not_found) și poate seta doar o listă nevidă din propriile colecții. O listă goală sau o colecție din afara listei ei returnează 400 api_keys.invalid_collections. Fără acest câmp, colecțiile cheii rămân neschimbate.
items ≤ 100
allowed_cidrsarray of string
Rețelele din care poate fi folosită cheia.
items ≤ 50
expires_atstring (date-time) | null
Momentul expirării (în viitor). null înseamnă că cheia nu expiră.

Folosit de

PATCH/v1/api-keys/{key_id}Actualizează o cheie API