ऑब्जेक्ट
ApiKeyUpdate
कुंजी में बदलाव। जो फ़ील्ड नहीं दिए जाते, वे नहीं बदलते, और data_profile वैकल्पिक है। ख़ाली scopes सूची का मतलब है रोल के हिसाब से स्कोप, ख़ाली collection_ids और allowed_cidrs का मतलब है कोई पाबंदी नहीं, और expires_at का मान null होने का मतलब है कि कुंजी की मियाद ख़त्म नहीं होती। जो कुंजी ख़ुद कलेक्शन तक सीमित है, वह कलेक्शन की पाबंदी (collection_ids) हटा या बढ़ा नहीं सकती।
फ़ील्ड
data_profilestringकुंजी की नई डेटा प्रोफ़ाइल। डेटा प्रोफ़ाइल रोल
adminपर लागू नहीं होती, इसलिए एडमिन कुंजी के लिएfullके अलावा कोई भी प्रोफ़ाइल400 api_keys.data_profile_not_applicableलौटाती है।scopesarray of ApiKeyScopeकुंजी के स्कोप। स्कोप
systemAPI से जारी नहीं होता।collection_idsarray of integerकुंजी को इन कलेक्शन तक सीमित करता है। ख़ाली सूची का मतलब है कोई पाबंदी नहीं। जो कॉल करने वाली कुंजी ख़ुद कलेक्शन तक सीमित है, वह सिर्फ़ अपने कलेक्शन वाली कुंजियाँ देखती और बदलती है (दूसरी कुंजियाँ
404 api_keys.not_foundलौटाती हैं) और सिर्फ़ अपने कलेक्शन की ग़ैर-ख़ाली सूची सेट कर सकती है। ख़ाली सूची या उसकी सूची से बाहर का कलेक्शन400 api_keys.invalid_collectionsलौटाता है। इस फ़ील्ड के बिना कुंजी के कलेक्शन नहीं बदलते।items ≤ 100
allowed_cidrsarray of stringवे नेटवर्क, जिनसे कुंजी इस्तेमाल की जा सकती है।
items ≤ 50
expires_atstring (date-time) | nullमियाद ख़त्म होने का समय (भविष्य में)।
nullका मतलब है कि कुंजी की मियाद ख़त्म नहीं होती।