> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/hi/authentication/authentication/manage-api-keys.md).

# API कुंजी प्रबंधन API

Roboflow REST API, roboflow api-key CLI, या MCP server के साथ workspace API keys बनाएं, सूचीबद्ध करें, अपडेट करें, सुरक्षित करें, निष्क्रिय करें, रोल करें और रद्द करें।

आप अपने वर्कस्पेस की API कुंजियों को कोड में प्रबंधित कर सकते हैं: कुंजियाँ बनाएँ, उनकी सूची देखें और उनका निरीक्षण करें, उनका नाम बदलें, मेटाडेटा जोड़ें, रोटेशन शेड्यूल सेट करें, और उन्हें निष्क्रिय, सुरक्षित, रोल या रद्द करें। डैशबोर्ड में यही काम करने के लिए देखें [डैशबोर्ड में API कुंजियाँ प्रबंधित करें](https://docs.roboflow.com/reference/hi/authentication/authentication/manage-api-keys-in-the-dashboard.md).

roboflow api-key [`roboflow api-key` CLI](#cli) और [Roboflow MCP सर्वर](https://docs.roboflow.com/agents/mcp-server) एक ही एंडपॉइंट का उपयोग करते हैं, इसलिए कोई एजेंट किसी की डैशबोर्ड से कुंजी कॉपी किए बिना, एप्लिकेशन के लिए आवश्यक कुंजी बना सकता है।

{% hint style="info" %}
गुप्त कुंजी का मान केवल कुंजी बनाते या रोल करते समय लौटाया जाता है। अन्य सभी एंडपॉइंट एक गैर-गुप्त `keyId` हैंडल और एक छोटा-सा `prefix`. यह मान बनाते समय किसी सीक्रेट स्टोर में या `.gitignore`'d `.env` फ़ाइल में सहेजें।
{% endhint %}

## HTTP API

### प्रमाणीकरण

निजी API कुंजी को इस रूप में भेजें `api_key` क्वेरी पैरामीटर या `Authorization: Bearer` हेडर का इस्तेमाल करें, जैसा कि बाकी सभी एंडपॉइंट पर होता है (देखें [REST API से प्रमाणित करें](https://docs.roboflow.com/reference/hi/platform/rest-api/authenticate-with-the-rest-api.md))। कुंजी पाथ में दिए गए वर्कस्पेस की होनी चाहिए। नीचे दिए गए हर एंडपॉइंट में आवश्यक [स्कोप](https://docs.roboflow.com/reference/hi/authentication/authentication/sign-in-with-roboflow-getting-started.md#available-scopes) बताया गया है। बिना स्कोप वाली (पूर्ण पहुँच वाली) कुंजी में ये सभी स्कोप होते हैं।

किसी उपयोगकर्ता की ओर से काम करने वाले OAuth टोकन के साथ, उपयोगकर्ता की भूमिका में भी उस कार्रवाई की अनुमति होनी चाहिए। डिफ़ॉल्ट रूप से, केवल वर्कस्पेस के मालिक और एडमिन API कुंजियों को मैनेज कर सकते हैं। स्कोप वाली कुंजी या OAuth टोकन केवल वही अनुमतियाँ दे सकता है जो कॉल करने वाले के पास पहले से हैं (देखें [विशेषाधिकार उपसमुच्चय नियम](#privilege-subset-rules)).

{% hint style="warning" %}
एक [प्रकाशन योग्य कुंजी](#the-publishable-key) (`rf_<workspaceId>`) इन एंडपॉइंट्स पर प्रमाणीकरण नहीं कर सकती। निजी कुंजी का उपयोग करें।
{% endhint %}

### API कुंजियों की सूची बनाएँ

वर्कस्पेस की कुंजियों को छिपे हुए रूप में और वर्कस्पेस की प्रकाशन योग्य कुंजी को सूचीबद्ध करता है। जब तक आप यह पास न करें, अक्षम कुंजियाँ शामिल नहीं की जातीं `includeDisabled=true`.

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys" method="get" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

### एक API कुंजी प्राप्त करें

किसी एक कुंजी का छिपे हुए रूप में मेटाडेटा लौटाता है, जिसे उसके `keyId`.

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys/{keyId}" method="get" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

### API कुंजी बनाएँ

एक कुंजी बनाता है। छोड़ दें `scopes` ताकि नई कुंजी को उस क्रेडेंशियल जैसी ही पहुँच मिले जो एंडपॉइंट को कॉल करता है। यह हर प्लान पर काम करता है, इसलिए स्क्रिप्ट का व्यवहार एक जैसा रहता है, चाहे वर्कस्पेस में Advanced API Keys हों या नहीं।

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys" method="post" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

{% hint style="danger" %}
यह `key` फ़ील्ड में गुप्त मान होता है, और यह केवल इसी रिस्पॉन्स में शामिल होता है। इसे अभी सहेज लें: आप इसे दोबारा प्राप्त नहीं कर सकते।
{% endhint %}

### API कुंजी अपडेट करें

कुंजी का नाम, स्कोप, मेटाडेटा या रोटेशन शेड्यूल बदलता है, उसे सुरक्षित करता है, या उसे निष्क्रिय अथवा फिर से सक्रिय करता है। केवल वे फ़ील्ड भेजें जिन्हें आप बदलना चाहते हैं। `scopes`, `customMetadata` और `owners` मौजूदा मानों की जगह लेते हैं।

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys/{keyId}" method="patch" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

### API कुंजी निरस्त करें

किसी कुंजी को स्थायी रूप से निरस्त करता है। इसका इस्तेमाल करने वाले ऐप्लिकेशन तुरंत प्रमाणीकरण करने में विफल हो जाते हैं।

Dedicated Deployment को संचालित करने वाली कुंजी निरस्त नहीं की जा सकती। पहले डिप्लॉयमेंट को कोई दूसरी कुंजी दें, या इसके बजाय कुंजी को रोल करें। इस कॉल को कोई और चीज़ नहीं रोकती, इसलिए पहले डैशबोर्ड की [निर्भरता चेतावनी](https://docs.roboflow.com/reference/hi/authentication/authentication/manage-api-keys-in-the-dashboard.md#dependency-warnings) और अपने उपभोक्ताओं की जाँच करें। Audit Logs में निरस्तीकरण के समय कुंजी की निर्भरताएँ दर्ज होती हैं। उनमें कुंजी का inference या read ट्रैफ़िक दर्ज नहीं होता, इसलिए वे यह नहीं बता सकते कि अब भी इसका इस्तेमाल कौन कर रहा है।

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys/{keyId}" method="delete" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

### API कुंजी रोल करें

एक ही कॉल में कुंजी को निरस्त करके उसका विकल्प बनाता है। पुरानी कुंजी पर चलने वाले Dedicated Deployments नई कुंजी पर चले जाते हैं। देखें [API कुंजियाँ रोटेट करें](https://docs.roboflow.com/reference/hi/authentication/authentication/rotate-api-keys.md) यह जानने के लिए कि कुंजी कब रोल करनी है और पहले क्या जाँचना है।

अगर किसी डिप्लॉयमेंट को स्थानांतरित नहीं किया जा सकता, तो कॉल विफल होकर `The API key was not rolled` (409, 423 या 502) लौटाती है और पुरानी कुंजी सक्रिय रहती है। त्रुटि के मुख्य भाग में एक बूलियन `retryable`होता है। दोबारा प्रयास केवल तभी करें, जब इसका मान `true`हो, और पहले कुंजियों की सूची देख लें: हो सकता है कि उसी नाम से कोई विकल्प कुंजी बनाई गई हो और सक्रिय रखी गई हो। `retryable` को `false` पर सेट करने वाली 409 त्रुटि का अर्थ यह हो सकता है कि डिप्लॉयमेंट पर API कुंजी का कोई नया अपडेट इस अपडेट की जगह ले चुका है। विकल्प कुंजी सक्रिय रहती है, और दोबारा प्रयास करने पर नया अपडेट ओवरराइट हो सकता है।

विकल्प कुंजी को नया `keyId`मिलता है, और इसके बाद उसका पुरानी कुंजी से कोई संबंध नहीं रहता। अगर आपको रोटेशन का पता लगाना हो, तो प्रतिक्रिया से `keyId` और `revokedKeyId` सहेजें। कॉल लौटते ही पुरानी कुंजी काम करना बंद कर देती है।

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys/{keyId}/roll" method="post" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

### मालिकों के लिए उम्मीदवारों की सूची बनाएँ

उन सदस्यों की सूची देता है जो कुंजी रोल कर सकते हैं। कुंजी के `owners` के रूप में केवल इन्हीं सदस्यों को बनाया, अपडेट या रोल करते समय चुना जा सकता है। इसे सेट करने से पहले कॉल करें `owners`, ताकि [रोटेशन रिमाइंडर](https://docs.roboflow.com/reference/hi/authentication/authentication/rotate-api-keys.md#rotation-reminders) उस व्यक्ति तक पहुँचे जो इस पर कार्रवाई कर सकता है।

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys/owner-candidates" method="get" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

### कुंजी को सुरक्षित करना

सुरक्षित कुंजी को API, CLI, MCP सर्वर या डैशबोर्ड से अक्षम, निरस्त या रोल नहीं किया जा सकता, और उसके स्कोप भी नहीं बदले जा सकते—जब तक कोई उसे असुरक्षित न करे। इसका इस्तेमाल किसी स्वचालित एजेंट को गलती से प्रोडक्शन कुंजी बंद करने से रोकने के लिए करें।

* सुरक्षित करने के लिए, यह भेजें: `{ "protected": true }` को [API कुंजी अपडेट करें](#update-an-api-key).
* असुरक्षित करने का विकल्प केवल [डैशबोर्ड](https://app.roboflow.com/settings/api)में है। API, CLI और MCP सर्वर किसी कुंजी को असुरक्षित नहीं कर सकते, इसलिए कोई समझौता किया गया या लापरवाह एजेंट सुरक्षा हटाकर कुंजी को निरस्त नहीं कर सकता।

### Publishable Key

हर वर्कस्पेस में इस प्रारूप की एक publishable key होती है: `rf_<workspaceId>`। यह:

* गुप्त नहीं होती: आप इसे ब्राउज़र कोड में रख सकते हैं (उदाहरण: [inferencejs](https://docs.roboflow.com/deployment/self-hosted/sdks/web-browser)).
* केवल इनफ़रेंस और मॉडल डाउनलोड तक सीमित: यह डेटा प्रबंधित नहीं कर सकता, ट्रेनिंग नहीं कर सकता या कुंजियाँ प्रबंधित नहीं कर सकता।
* स्थायी: यह वर्कस्पेस ID से आती है, इसलिए आप इसे बना, रोटेट या निरस्त नहीं कर सकते।

लिस्ट और क्रिएट के जवाबों में यह इस नाम से शामिल होती है: `publishableKey`, या आप इसे अलग से पढ़ सकते हैं:

{% openapi src="/files/33025fc52aff6719715d3e032dc6e7c55e47a673" path="/{workspace}/api-keys/publishable" method="get" %}
[api-keys.yaml](https://4110124481-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgmbAGf4KNeNPXGuUuKYv%2Fuploads%2Fgit-blob-903dbedaeeaec4584f555ddfc1ad9e1be5ac0320%2Fapi-keys.yaml?alt=media)
{% endopenapi %}

ब्राउज़र और एज इनफ़रेंस के लिए प्रकाशन योग्य कुंजी और सर्वर के काम के लिए स्कोप वाली निजी कुंजी का इस्तेमाल करें। प्रकाशन योग्य कुंजी रखने वाला कोई भी व्यक्ति वर्कस्पेस के मॉडल से इनफ़रेंस चला सकता है और उन्हें डाउनलोड कर सकता है। यह इसी उद्देश्य से किया गया समझौता है।

### अनुमतियों के उपसमुच्चय के नियम

आप जो कुंजी बनाते या अपडेट करते हैं, उसके पास उसे बनाने वाले क्रेडेंशियल से अधिक अनुमतियाँ कभी नहीं हो सकतीं:

* स्कोप वाली निजी कुंजी का इस्तेमाल करने पर, नई कुंजी के `scopes` कॉल करने वाली कुंजी के स्कोप का उपसमुच्चय होने चाहिए, और उसके `folderIds` कॉल करने वाली कुंजी के फ़ोल्डरों का उपसमुच्चय होने चाहिए। बिना स्कोप वाली (पूर्ण पहुँच वाली) कुंजी कोई भी अनुमति दे सकती है।
* किसी उपयोगकर्ता की ओर से काम करने वाले OAuth टोकन के साथ, अनुरोधित स्कोप की जाँच उस उपयोगकर्ता की भूमिका के आधार पर भी की जाती है। आप केवल वे अनुमतियाँ दे सकते हैं जिनकी आपकी भूमिका अनुमति देती है।
* सभी फ़ोल्डरों की कुंजी के लिए (बिना `folderIds` के) ऐसा उपयोगकर्ता चाहिए जो हर फ़ोल्डर देख सकता हो। जिन वर्कस्पेस मालिकों के पास सभी फ़ोल्डरों की पहुँच नहीं है, उन्हें उन फ़ोल्डरों की सूची देनी होगी जिन तक कुंजी पहुँच सकती है। वेब ऐप में कुंजी बनाते समय भी यह लागू होता है।

कॉल करने वाला जितनी अनुमतियाँ दे सकता है, उससे अधिक माँगने वाले अनुरोध लौटाते हैं `403`.

### त्रुटियाँ

ऊपर दिए गए हर एंडपॉइंट में उसकी त्रुटि स्थितियाँ सूचीबद्ध हैं। उन सभी पर दो बातें लागू होती हैं:

* जिस क्रेडेंशियल के पास रूट का स्कोप नहीं है, उसे मिलता है `404`, न कि `403`, ताकि Roboflow यह ज़ाहिर न करे कि संसाधन मौजूद है या नहीं। `403` का मतलब है कि कॉल करने वाला कुंजियाँ प्रबंधित कर सकता है, लेकिन उसने अपने पास मौजूद अनुमतियों से अधिक माँगी हैं, या प्लान में उन्नत API कुंजियाँ उपलब्ध नहीं हैं।
* त्रुटि बॉडी के दो रूप हैं। ज़्यादातर त्रुटियाँ एक स्ट्रिंग लौटाती हैं, `{"error": "Some message"}`। प्रमाणीकरण परत एक ऑब्जेक्ट लौटाती है, `{"error": {"message": "...", "type": "...", "hint": "..."}}`, जब कुंजी गायब या अमान्य हो (`401`) और जब स्कोप गायब हो या वर्कस्पेस गलत हो (`404`)। दोनों को संभालें। विफल रोटेशन (`409`, `423` या `502`) में स्ट्रिंग के साथ एक बूलियन जोड़ा जाता है: `{"error": "The API key was not rolled. ...", "retryable": false}`.

सामान्य त्रुटि फ़ॉर्मैट के लिए [त्रुटियाँ और स्थिति कोड](https://docs.roboflow.com/reference/hi/errors-and-status-codes.md) देखें।

## CLI

यह `roboflow api-key` कमांड समूह आपको टर्मिनल से अपने वर्कस्पेस की API कुंजियाँ प्रबंधित करने देता है। यह [API कुंजी REST एंडपॉइंट](#http-api) का इस्तेमाल करता है और आपके CLI कॉन्फ़िगरेशन से वर्कस्पेस और क्रेडेंशियल लेता है (देखें [CLI इंस्टॉल और सेट अप करें](https://docs.roboflow.com/reference/hi/platform/cli/install-and-set-up-the-cli.md)).

{% hint style="info" %}
पूरा सीक्रेट मान केवल कुंजी बनाते या रोटेट करते समय दिखाया जाता है। इसे तुरंत सहेज लें: `list` और `get` इसे फिर कभी नहीं दिखाते। यह `roll` कमांड और रोटेशन फ़्लैग `create` और `update` के लिए roboflow 1.7.3 या उसके बाद का संस्करण चाहिए।
{% endhint %}

```bash
roboflow api-key --help
```

<table data-search="false"><thead><tr><th width="180">कमांड</th><th>विवरण</th></tr></thead><tbody><tr><td><code>list</code></td><td>वर्कस्पेस की API कुंजियों की सूची दिखाएँ।</td></tr><tr><td><code>get</code></td><td>किसी एक कुंजी का विवरण दिखाएँ।</td></tr><tr><td><code>create</code></td><td>नई कुंजी बनाएँ (सीक्रेट केवल एक बार दिखाया जाता है)।</td></tr><tr><td><code>update</code></td><td>कुंजी का नाम, स्कोप, मेटाडेटा या रोटेशन शेड्यूल अपडेट करें।</td></tr><tr><td><code>protect</code></td><td>कुंजी को सुरक्षित के रूप में चिह्नित करें।</td></tr><tr><td><code>disable</code></td><td>कुंजी को निष्क्रिय करें या फिर से सक्रिय करें।</td></tr><tr><td><code>revoke</code></td><td>कुंजी को स्थायी रूप से रद्द करें।</td></tr><tr><td><code>roll</code></td><td>कुंजी रद्द करके उसकी जगह नई कुंजी बनाएँ (नया सीक्रेट केवल एक बार दिखाया जाता है)।</td></tr><tr><td><code>publishable</code></td><td>वर्कस्पेस की सार्वजनिक कुंजी प्रिंट करें।</td></tr></tbody></table>

स्क्रिप्टिंग के लिए मशीन-पठनीय आउटपुट पाने हेतु `--json` (एक ग्लोबल फ़्लैग, कमांड से पहले), उदाहरण के लिए, जोड़ें `roboflow --json api-key list`.

### कुंजियों की सूची बनाएँ

```bash
roboflow api-key list
roboflow api-key list --include-disabled --include-folders
```

### एक कुंजी प्राप्त करें

कुंजियों की पहचान उनके `keyId` (गैर-सीक्रेट हैंडल, जो `list`):

```bash
roboflow api-key get <key_id>
```

### कुंजी बनाएँ

```bash
# कॉल करने वाले क्रेडेंशियल के स्कोप विरासत में मिलते हैं (कॉल करने वाले के पास पूर्ण ऐक्सेस होने पर पूर्ण-ऐक्सेस कुंजी)
roboflow api-key create "my-app"

# स्कोप वाली कुंजी (--scope को बार-बार दें; इसके लिए Advanced API Keys आवश्यक हैं)
roboflow api-key create "inference-only" --scope model:infer

# भूमिका प्रीसेट - किसी RBAC भूमिका के स्कोप दें (अंतर्निर्मित या कस्टम भूमिका का नाम);
# स्पष्ट स्कोप के साथ संयोजित किया जा सकता है। role:owner का अर्थ है पूर्ण ऐक्सेस।
roboflow api-key create "reviewer-bot" --scope role:reviewer --scope model:infer

# फ़ोल्डर-स्कोप वाली + सुरक्षित
roboflow api-key create "edge-device" --folder <folder_id> --protected

# मेटाडेटा जोड़ें (--metadata को बार-बार दें; इसके लिए Advanced API Keys आवश्यक हैं)
roboflow api-key create "ci-key" --metadata team=vision --metadata env=prod

# रोटेशन की नियत तारीख और उससे पहले याद दिलाए जाने वाले सदस्य सेट करें (दोहराने के लिए --owner; Advanced API Keys आवश्यक)
roboflow api-key create "line-3-gateway" --rotation-due-at 2027-10-22 --owner <member_id> --owner <member_id>
```

सीक्रेट केवल एक बार दिखाया जाता है। इसे किसी स्क्रिप्ट में लेने के लिए, इस्तेमाल करें `--json` और पाइप करें `jq`:

```bash
roboflow --json api-key create "ci-key" | jq -r .key > .env.key
```

{% hint style="warning" %}
`--scope`, `--folder`, `--metadata`, `--rotation-due-at` और `--owner` के लिए Advanced API Keys प्लान सुविधा आवश्यक है, और आप केवल वे अनुमतियाँ दे सकते हैं जो कमांड चलाने वाले क्रेडेंशियल के पास पहले से हैं। CLI API key से प्रमाणित होता है, इसलिए बिना बनाए गए key में `--owner` कोई मालिक नहीं होता और उसे रोटेट कर सकने वाले सभी लोगों को रिमाइंडर भेजा जाता है।
{% endhint %}

### कुंजी अपडेट करें

```bash
# नाम बदलें
roboflow api-key update <key_id> --name "renamed-key"

# कुंजी के स्कोप बदलें (--scope दोहराएँ)
roboflow api-key update <key_id> --scope model:infer --scope project:read

# कुंजी का मेटाडेटा बदलें (--metadata दोहराएँ)
roboflow api-key update <key_id> --metadata team=vision --metadata env=prod

# रोटेशन शेड्यूल सेट या साफ़ करें
roboflow api-key update <key_id> --rotation-due-at 2027-10-22 --owner <member_id>
roboflow api-key update <key_id> --clear-rotation-due-at --clear-owners
```

`--scope` कुंजी के मौजूदा स्कोप को हटाकर ठीक वही सेट लागू करता है जो आप देते हैं, `--metadata` कुंजी का मेटाडेटा बदलता है, और `--owner` उसके मालिकों को बदलता है। `--clear-owners` मालिकों की सूची खाली कर देता है, ताकि कुंजी रोटेट कर सकने वाले सभी लोगों को रिमाइंडर भेजा जाए। भेजें `--name` केवल इसे नाम बदलने के लिए इस्तेमाल करें, बाकी चीज़ों को बदले बिना।

{% hint style="warning" %}
स्कोप, मेटाडेटा या रोटेशन शेड्यूल बदलने के लिए Advanced API Keys प्लान सुविधा आवश्यक है (--name से नाम बदलने के लिए यह आवश्यक नहीं है)। `--name` की तरह, `create`, आप केवल वही स्कोप दे सकते हैं जो कमांड चलाने वाले क्रेडेंशियल के पास पहले से हैं।
{% endhint %}

### कुंजी को सुरक्षित / असुरक्षित करें

```bash
roboflow api-key protect <key_id>
```

सुरक्षित कुंजी को CLI, API या MCP के ज़रिए निष्क्रिय, निरस्त या रोटेट नहीं किया जा सकता। इसे असुरक्षित केवल [डैशबोर्ड](https://app.roboflow.com/settings/api)में किया जा सकता है। जानबूझकर कोई `unprotect` कमांड नहीं है, ताकि कोई स्वचालित वर्कफ़्लो सुरक्षा हटाकर एक ही चरण में प्रोडक्शन कुंजी निरस्त न कर सके।

### कुंजी निष्क्रिय करें / फिर से सक्षम करें

```bash
roboflow api-key disable <key_id>            # disable
roboflow api-key disable <key_id> --enable   # फिर से सक्षम करें
```

अक्षम की गई कुंजियों को API अस्वीकार करता है, लेकिन उन्हें फिर से सक्षम किया जा सकता है। संरक्षित कुंजी को अक्षम नहीं किया जा सकता।

{% hint style="warning" %}
`roboflow api-key disable` (और इसे फिर से सक्षम करने के लिए `--enable`) के लिए **Advanced API Keys** प्लान सुविधा आवश्यक है, ठीक वैसे ही जैसे स्कोप वाली `create` के साथ `--scope`/`--folder`। यह [REST API](#update-an-api-key).
{% endhint %}

### से मेल खाता है।

```bash
कुंजी रद्द करें
roboflow api-key revoke <key_id>          # पुष्टि के लिए संकेत देता है
```

कुंजी रद्द करना स्थायी है। संरक्षित कुंजी को CLI से रद्द नहीं किया जा सकता: पहले डैशबोर्ड में उसका संरक्षण हटाएँ। Dedicated Deployment को सक्रिय रखने वाली कुंजी तब तक रद्द नहीं की जा सकती, जब तक डिप्लॉयमेंट को दूसरी कुंजी न मिल जाए।

### कुंजी बदलें

```bash
roboflow api-key roll <key_id>          # पुष्टि के लिए संकेत देता है
roboflow api-key roll <key_id> --yes    # संकेत छोड़ें (स्क्रिप्ट के लिए)

# प्रतिस्थापन कुंजी का रोटेशन शेड्यूल सेट करें (इसके लिए Advanced API Keys आवश्यक है)
roboflow api-key roll <key_id> --yes --rotation-due-at 2027-10-22 --owner <member_id>
```

कुंजी बदलने पर एक ही चरण में पुरानी कुंजी रद्द हो जाती है और उसकी जगह नई कुंजी बन जाती है। नई कुंजी में पुरानी कुंजी का नाम, स्कोप, फ़ोल्डर और मेटाडेटा बरकरार रहते हैं, जबकि पुरानी कुंजी का मान तुरंत काम करना बंद कर देता है। यदि Dedicated Deployment को नई कुंजी पर स्थानांतरित नहीं किया जा सकता, तो कमांड "The API key was not rolled" त्रुटि के साथ विफल हो जाती है; पुरानी कुंजी सक्रिय रहती है और नई कुंजी शायद पहले ही बन चुकी हो। इसलिए दोबारा प्रयास करने से पहले `list` चलाएँ। पुरानी कुंजी का शेड्यूल बनाए रखने के लिए `--rotation-due-at` और `--owner` छोड़ दें। नई गोपनीय कुंजी को आउटपुट से या `--json`:

```bash
set -o pipefail
key=$(roboflow --json api-key roll <key_id> --yes | jq -er .key) || exit 1
```

बदलने की प्रक्रिया विफल होने पर उसकी त्रुटि stderr पर प्रिंट होती है और कमांड गैर-शून्य स्थिति कोड के साथ बाहर निकलता है। `pipefail` और `jq -e`के बिना पाइपलाइन फिर भी सफल रहती है और स्क्रिप्ट खाली कुंजी के साथ आगे चलती रहती है।

संरक्षित कुंजी को CLI से नहीं बदला जा सकता: पहले डैशबोर्ड में उसका संरक्षण हटाएँ। किसी कुंजी को केवल एक बार बदला जा सकता है। इसके बाद उसका `keyId` नहीं मिलता, और `keyId` में नई कुंजी की `list` का उससे कोई लिंक नहीं रहता। इसलिए बदलने के आउटपुट से दोनों ID दर्ज कर लें। देखें [API Keys घुमाएँ](https://docs.roboflow.com/reference/hi/authentication/authentication/rotate-api-keys.md) पूरी कटओवर प्रक्रिया के लिए।

### पब्लिश करने योग्य कुंजी पाएँ

```bash
roboflow api-key publishable
roboflow --json api-key publishable | jq -r .publishableKey
```

पब्लिश करने योग्य कुंजी (`rf_<workspaceId>`) गोपनीय नहीं है और इसे ब्राउज़र / [inferencejs](https://docs.roboflow.com/deployment/self-hosted/sdks/web-browser) कोड में सुरक्षित रूप से एम्बेड किया जा सकता है। यह केवल इन्फ़रेंस के लिए है और इसे बनाया या निरस्त नहीं किया जा सकता। विवरण के लिए देखें [पब्लिशेबल कुंजी](#the-publishable-key) ।

## MCP सर्वर

अपने AI एजेंट को इससे कनेक्ट करें [MCP सर्वर](https://docs.roboflow.com/agents/mcp-server) और यह इन टूल की मदद से API कुंजियों को प्रबंधित कर सकता है:

<table data-search="false"><thead><tr><th width="290">टूल</th><th>विवरण</th></tr></thead><tbody><tr><td><code>api_keys_list</code></td><td>वर्कस्पेस की सभी API कुंजियों की सूची दें।</td></tr><tr><td><code>api_keys_get</code></td><td>एक कुंजी का मेटाडेटा प्राप्त करें।</td></tr><tr><td><code>api_keys_get_publishable</code></td><td>वर्कस्पेस की पब्लिशेबल कुंजी प्राप्त करें।</td></tr><tr><td><code>api_keys_create</code></td><td>नई API कुंजी बनाएँ।</td></tr><tr><td><code>api_keys_update</code></td><td>कुंजी का नाम, स्कोप, मेटाडेटा या रोटेशन शेड्यूल अपडेट करें।</td></tr><tr><td><code>api_keys_protect</code></td><td>कुंजी को सुरक्षित के रूप में चिह्नित करें।</td></tr><tr><td><code>api_keys_disable</code></td><td>कुंजी को निरस्त किए बिना उसे निष्क्रिय या फिर से सक्रिय करें।</td></tr><tr><td><code>api_keys_revoke</code></td><td>कुंजी को स्थायी रूप से रद्द करें।</td></tr><tr><td><code>api_keys_roll</code></td><td>कुंजी निरस्त करें और एक ही चरण में उसका प्रतिस्थापन बनाएँ। नई गोपनीय कुंजी केवल एक बार लौटाई जाती है।</td></tr><tr><td><code>api_keys_owner_candidates</code></td><td>उन सदस्यों की सूची दें जो कुंजी को बदल सकते हैं, ताकि एजेंट केवल ऐसे मालिक तय करे जिन तक रिमाइंडर पहुँच सके।</td></tr></tbody></table>

MCP सर्वर किसी कुंजी का सुरक्षा-प्रतिबंध नहीं हटा सकता। प्रतिबंधित कुंजी तब तक प्रतिबंधित रहती है, जब तक कोई व्यक्ति डैशबोर्ड में उसका प्रतिबंध न हटा दे।

`api_keys_create` और `api_keys_roll` नई गोपनीय कुंजी एजेंट को लौटाते हैं, इसलिए वह एजेंट की बातचीत और लॉग में शामिल हो जाती है। उन प्रतिलेखों को संवेदनशील मानें, या इसके बजाय डैशबोर्ड से कुंजियाँ बनाएँ।
