Platform REST API Documentation | प्लेटफॉर्म REST API दस्तावेज़ीकरण

Core Structure Developer Guide. Control isolated container image nodes, handle remote microservice accounts, and securely deliver automated cloud cluster signals via a clearly tokenized payload interface.
कोर आर्किटेक्चर डेवलपर गाइड में आपका स्वागत है। पृथक कंटेनर इमेज नोड्स प्रबंधित करें, रिमोट माइक्रोसर्विस अकाउंट्स को हैंडल करें, और स्पष्ट रूप से टोकनाइज्ड पेलोड इंटरफ़ेस के माध्यम से स्वचालित क्लाउड क्लस्टर सिग्नलों को सुरक्षित रूप से डिलीवर करें।

System Architecture Overview / सिस्टम आर्किटेक्चर सिंहावलोकन

The DevRegistry REST interface is built around predictable, atomic endpoints. All data transactions are processed over secure HTTPS, using serialized JSON blocks for requests and standard structured data for server responses.
DevRegistry REST इंटरफ़ेस पूरी तरह से पूर्वानुमानित और एटॉमिक एंडपॉइंट्स पर आधारित है। सभी डेटा लेनदेन सुरक्षित HTTPS प्रोटोकॉल के माध्यम से संसाधित किए जाते हैं, जिसमें अनुरोधों (Requests) के लिए सीरियलाइज्ड JSON ब्लॉक्स और सर्वर प्रतिक्रियाओं (Responses) के लिए मानक संरचित डेटा का उपयोग किया जाता है।

Production Base URI Path / प्रोडक्शन बेस URI पाथ: https://api.devregistry.local/v1

All administrative processes require structured transport headers. Content definitions must strictly match the following system mapping rules:
सभी प्रशासनिक प्रक्रियाओं के लिए संरचित ट्रांसपोर्ट हेडर की आवश्यकता होती है। सामग्री परिभाषाएं निम्नलिखित सिस्टम मैपिंग नियमों से कड़ाई से मेल खानी चाहिए:

Header Key / हेडर कुंजी Expected Standard Content Mapping / अपेक्षित मानक सामग्री मैपिंग
Accept application/json
Content-Type application/json; charset=utf-8

Rate Throttling (Rate Limits) / दर सीमा (रेट लिमिट)

To protect database pool allocation and ensure uniform cluster performance, API identities are restricted by a uniform rate window. Rate limiting metrics are evaluated and returned within explicit response header objects for each programmatic transaction sequence.
डेटाबेस पूल आवंटन की सुरक्षा और समान क्लस्टर प्रदर्शन प्रदान करने के लिए, API पहचान को एक समान दर विंडो द्वारा सीमित किया जाता है। प्रत्येक प्रोग्रामेटिक लेनदेन अनुक्रम के लिए स्पष्ट प्रतिक्रिया हेडर ऑब्जेक्ट के भीतर एक्सेस सीमाओं का मूल्यांकन और वापसी की जाती है।

Returned Header Token / लौटाया गया हेडर टोकन Description / Data Definition Context ¦ विवरण / डेटा परिभाषा संदर्भ
X-RateLimit-Limit The total number of allowed request events within a single window period (e.g., 5000 per hour).
एकल विंडो अवधि के भीतर अनुमत कुल अनुरोधों की संख्या (जैसे, 5000 प्रति घंटा)।
X-RateLimit-Remaining The remaining request allowance metrics valid within the current system monitoring window.
वर्तमान सिस्टम मॉनिटरिंग अवधि के भीतर वैध शेष अनुरोध सीमा मीट्रिक।
X-RateLimit-Reset An explicit Unix epoch timestamp string indicating the exact time when the current restriction block will be lifted.
एक स्पष्ट यूनिक्सEpoch टाइमस्टैम्प स्ट्रिंग जो वह सटीक समय बताती है जब वर्तमान प्रतिबंध ब्लॉक हटा दिया जाएगा।

Initial Handshake Authentication / प्रारंभिक हैंडशेक प्रमाणीकरण

Issue short-lived bearer keys using cryptographically signed, long-term service account credentials. Use the returned context token to securely perform structural modifications on container assets.
क्रिप्टोग्राफिक रूप से हस्ताक्षरित दीर्घकालिक सेवा खाता मानों का उपयोग करके अल्पकालिक बियरर कुंजियाँ (Bearer Keys) जारी करें। कंटेनर संपत्तियों पर सुरक्षित रूप से संरचनात्मक परिवर्तन करने के लिए लौटाए गए संदर्भ टोकन का उपयोग करें।

POST /auth/tokens

Payload Schema Parameters / पेलोड स्कीमा पैरामीटर

Target Key / लक्ष्य कुंजी Data Type / डेटा प्रकार Requirement / अनिवार्यता
client_idstring An explicit and unique service account identifier key.
एक स्पष्ट और विशिष्ट सेवा खाता पहचानकर्ता कुंजी।
Required / अनिवार्य
secret_keystring An encrypted secret token block paired directly with the active client ID.
एक एन्क्रिप्टेड सीक्रेट टोकन ब्लॉक जो सीधे सक्रिय क्लाइंट आईडी के साथ जोड़ा जाता है।
Required / अनिवार्य
Request JSON Block / अनुरोध JSON ब्लॉक
{
  "client_id": "srv_acc_01j15",
  "secret_key": "dGhpcy1pcy1hLXNlY3VyZS1rZXk="
}
Response Shape / प्रतिक्रिया स्वरूप (201 Created)
{
  "status": "authenticated",
  "token": "eyJhbGciOiJIUzI1NiIsInR5c",
  "expires_in": 3600
}

Repository Catalog Query / रिपॉजिटरी कैटलॉग क्वेरी

Retrieve a complete array object highlighting targeted repository container records, detailed image file layer metrics, tag lists, and historical image generation checkpoints from internal clusters.
लक्षित रिपॉजिटरी कंटेनर रिकॉर्ड, विस्तृत इमेज फ़ाइल लेयर मेट्रिक्स, टैग सूचियों और आंतरिक क्लस्टर से ऐतिहासिक इमेज जनरेशन चेकपॉइंट को हाइलाइट करने वाली एक पूर्ण ऐरे (Array) ऑब्जेक्ट प्राप्त करें।

GET /packages/tags

Target Query Modifiers / लक्ष्य क्वेरी संशोधक

Modifier Key / संशोधक कुंजी Data Type / डेटा प्रकार Requirement / अनिवार्यता
namespacestring Target string key grouping associated isolated application builds.
संबंधित पृथक एप्लिकेशन बिल्ड को समूहीकृत करने वाली लक्षित स्ट्रिंग कुंजी।
Required / अनिवार्य
limitinteger Maximum pagination output record count. Upper range limit is 100.
अधिकतम पेजिंग आउटपुट रिकॉर्ड संख्या। ऊपरी सीमा 100 है।
Optional [Default: 20] / वैकल्पिक [प्रारंभिक मान: 20]
cURL Request Interface / cURL अनुरोध इंटरफ़ेस
curl -X GET https://api.devregistry.local/v1/packages/tags?namespace=nodejs \
  -H "Authorization: Bearer eyJhbGciOiJI..."
Response Payload / प्रतिक्रिया पेलोड (200 OK)
{
  "namespace": "nodejs",
  "tags": [
    "18-alpine",
    "20-debian",
    "latest"
  ],
  "total_count": 3
}

Container Artifact Purge / कंटेनर आर्टिफ़ैक्ट विलोपन

Immediately and securely purge targeted binary image nodes, build tags, or decommissioned layer footprints from the underlying block storage array.
अंतर्निहित ब्लॉक स्टोरेज एरे से लक्षित बाइनरी इमेज नोड्स, बिल्ड टैग, या अनुपयोगी लेयर फ़ुटप्रिंट को तुरंत और सुरक्षित रूप से पूरी तरह से हटा दें।

Operational Warning / परिचालन चेतावनी: Executed deletion processes are irreversible and cannot be recovered from cache files.
निष्पादित विलोपन प्रक्रियाएं अपरिवर्तनीय हैं और इन्हें कैश फ़ाइलों से पुनर्प्राप्त नहीं किया जा सकता है।
DELETE /packages/purge

Payload Selection Parameters / पेलोड चयन पैरामीटर

Key Path / कुंजी पथ Data Type / डेटा प्रकार Requirement / अनिवार्यता
registry_pathstring Precise absolute path reference specifying the target image.
लक्षित इमेज को निर्दिष्ट करने वाला सटीक पूर्ण पथ संदर्भ।
Required / अनिवार्य
target_tagstring Isolated tag string node targeted for removal.
हटाने के लिए लक्षित पृथक टैग स्ट्रिंग नोड।
Required / अनिवार्य
Request Body Schema / अनुरोध बॉडी स्कीमा
{
  "registry_path": "/withmez/nodejs",
  "target_tag": "latest"
}
Response Payload / प्रतिक्रिया पेलोड (200 OK)
{
  "purged": true,
  "released_bytes": 524288000,
  "timestamp": 1783008966
}

Event Webhook Target Registration / इवेंट वेबहुक लक्ष्य पंजीकरण

Configure automated system triggers to stream real-time HTTP payload blocks to external third-party servers whenever package updates or deletion operations complete across the network registry.
नेटवर्क रजिस्ट्री में पैकेज अपडेट या विलोपन संचालन पूरा होने पर बाहरी तृतीय-पक्ष सर्वर पर रीयल-टाइम HTTP पेलोड ब्लॉक स्ट्रीम करने के लिए स्वचालित सिस्टम ट्रिगर्स कॉन्फ़िगर करें।

POST /webhooks/endpoints

Configuration Rules / कॉन्फ़िगरेशन नियम

Key Name / कुंजी नाम Data Type / डेटा प्रकार Requirement / अनिवार्यता
target_urlstring Destination endpoint URL to receive the streamed webhook requests.
स्ट्रीम किए गए वेबहुक अनुरोधों को प्राप्त करने के लिए गंतव्य एंडपॉइंट URL।
Required / अनिवार्य
subscribed_eventsarray [string] Array of event criteria strings matching execution logs (e.g., image.push, image.purge).
निष्पादन लॉग से मेल खाने वाले इवेंट मानदंड स्ट्रिंग्स का ऐरे (जैसे, image.push, image.purge)।
Required / अनिवार्य
Webhook Configuration Payload / वेबहुक कॉन्फ़िगरेशन पेलोड
{
  "target_url": "https://notify.services.local/receiver",
  "subscribed_events": [
    "image.push",
    "image.purge"
  ]
}
Response Shape / प्रतिक्रिया स्वरूप (201 Created)
{
  "webhook_id": "whk_88201a",
  "active": true,
  "created_at": 1783009412
}

Global Error Definition Dictionary / वैश्विक त्रुटि परिभाषा शब्दकोश

In case of query failures, the backend gateway rejects processing with a clear, descriptive HTTP payload format paired with specific system tracking flags.
क्वेरी विफलताओं के मामले में, बैकएंड गेटवे विशिष्ट सिस्टम ट्रैकिंग फ़्लैग के साथ जुड़े एक स्पष्ट, वर्णनात्मक HTTP पेलोड प्रारूप के साथ प्रसंस्करण को अस्वीकार कर देता है।

HTTP Status / HTTP स्थिति Error Flag Definition / त्रुटि फ़्लैग परिभाषा Resolution Context Mapping / समाधान संदर्भ मैपिंग
400 Bad Request INVALID_PAYLOAD_FORMAT The request body cannot be evaluated as validated schema JSON. Check quote symmetry.
अनुरोध बॉडी का मूल्यांकन मान्य स्कीमा JSON के रूप में नहीं किया जा सकता है। उद्धरण चिह्नों (Quotes) की समरूपता की जाँच करें।
401 Unauthorized EXPIRED_BEARER_TOKEN The provided context token has expired. Request an atomic session handshake loop.
प्रदान किए गए संदर्भ टोकन की अवधि समाप्त हो गई है। एक नए सेशन हैंडशेक लूप का अनुरोध करें।
403 Forbidden INSUFFICIENT_NODE_PRIVILEGES The current active identity lacks absolute privilege metrics to execute asset deletion.
वर्तमान सक्रिय पहचान में संपत्ति विलोपन निष्पादित करने के लिए आवश्यक पूर्ण विशेषाधिकार मेट्रिक्स की कमी है।
429 Too Many Requests RATE_LIMIT_EXCEEDED Identity transaction threshold limits reached. Await restriction block release reset.
पहचान लेनदेन सीमा समाप्त हो गई है। प्रतिबंध ब्लॉक हटने और रीसेट होने की प्रतीक्षा करें।