ऑराबेस लोगो
aurabaseडॉक्स
डॉक्स›Edge Functions›HTTP API reference

Edge Functions HTTP एपीआई संदर्भ

फ़ंक्शन सेवा की संपूर्ण HTTP सतह, प्रत्येक रूट के लिए आवश्यक भूमिका के साथ।

10 मि॰ पढ़ें·स्तर संदर्भ·12 अक्टू॰ 2026 पर संशोधित
यह अंग्रेजी पाठ फ़्रेंच मूल से स्वचालित रूप से उत्पन्न हुआ था और अभी तक इसकी समीक्षा नहीं की गई है।
यह पृष्ठ स्वचालित रूप से अनुवादित किया गया था. अंग्रेजी संस्करण प्रामाणिक है.
#
कन्वेंशनों

1. कन्वेंशन

बेस यूआरएल. आपके प्रोजेक्ट का URL, उदाहरण के लिए https://my-app.aurabase.cloud। प्रोजेक्ट की पहचान होस्ट द्वारा की जाती है, इसलिए नीचे दिए गए पथों में कोई प्रोजेक्ट आईडी नहीं है। लंबा फॉर्म /v1/functions/{project_id}/… भी स्वीकार किया जाता है।

प्रमाणीकरण. अपनी कुंजी apikey हेडर में भेजें। साइन-इन उपयोगकर्ता के रूप में कॉल करने के लिए Authorization: Bearer <JWT> जोड़ें। स्टूडियो उन्हीं मार्गों को कंसोल सत्र टोकन के साथ कॉल करता है, जो इसे admin भूमिका देता है।

भूमिकाआप इसे कैसे प्राप्त करते हैंकॉल कर सकते हैं
anonपरियोजना की सार्वजनिक कुंजीPOST …/invoke
authenticatedसार्वजनिक कुंजी और उपयोगकर्ता की JWTPOST …/invoke
service_roleservice_role कुंजी (केवल सर्वर)नीचे हर मार्ग
adminएक कंसोल सत्र (स्टूडियो)नीचे हर मार्ग

कोई अन्य मार्ग 403 से anon और authenticated का उत्तर देता है:

403json
{ "error": { "code": "FORBIDDEN", "type": "forbidden", "request_id": "…",
  "message": "Accès interdit : Opération réservée au rôle service_role : seule l'invocation d'une fonction est ouverte aux clés publiques" } }

प्रारूप. निकाय JSON हैं और उन्हें Content-Type: application/json की आवश्यकता है। एक सफलता { "data": …, "meta": null } है। एक विफलता { "error": { "code", "message", "type", "request_id" } } है।

फ़ंक्शन ऑब्जेक्ट।

मैदानप्रकार
id, project_id, nameडोरी
runtime"deno" या "wasm"
codeडोरीdeno के लिए स्रोत; wasm के लिए संकलित बाइनरी का बेस64
code_hashडोरीcode का SHA-256
env_varsवस्तुमूल्य की कुंजी
permissionsवस्तुallow_net (स्ट्रिंग सरणी), memory_mb, timeout_secs
is_activeबूलियन
created_at, updated_atआईएसओ 8601
#
प्रबंधित करना

2. कार्य

विधि और मार्गभूमिकाशरीरप्रतिक्रिया
GET /v1/functionsसेवा_भूमिकाकोई नहींफ़ंक्शन ऑब्जेक्ट की सरणी
POST /v1/functionsसेवा_भूमिका{ name, runtime, code, env_vars? }फ़ंक्शन ऑब्जेक्ट
GET /v1/functions/{name}सेवा_भूमिकाकोई नहींफ़ंक्शन ऑब्जेक्ट. {name} वह नाम या आईडी है जब किसी फ़ंक्शन का वह नाम नहीं है।
PATCH /v1/functions/{name}सेवा_भूमिका{ code?, env_vars?, is_active?, permissions? }फ़ंक्शन ऑब्जेक्ट
DELETE /v1/functions/{name}सेवा_भूमिकाकोई नहीं{ "data": null }
GET /v1/functions/{name}/codeसेवा_भूमिकाकोई नहीं{ "data": { "code": "…" } }
GET /v1/functions/{name}/envसेवा_भूमिकाकोई नहीं{ "data": [ { "key", "value" } ] }, मान डिक्रिप्ट किया गया
PUT /v1/functions/{name}/envसेवा_भूमिका{ "vars": [ { "key", "value" } ] }{ "data": null }

टिप्पणियाँ:

  • POST name का एक संस्करण है: किसी मौजूदा नाम को पोस्ट करने से उसका कोड बदल जाता है। उस निकाय में एक env_vars फ़ील्ड मौजूदा चर को प्रतिस्थापित करता है; उन्हें रखने के लिए इसे छोड़ दें.
  • PATCH में, permissions को फ़ील्ड दर फ़ील्ड मर्ज किया जाता है: { "permissions": { "timeout_secs": 60 } } allow_net और memory_mb रखता है। अपनी सीमा के बाहर का फ़ील्ड 400 लौटाता है।
  • PUT …/env वेरिएबल के पूरे सेट को प्रतिस्थापित करता है और यह एकमात्र मार्ग है जो उन्हें एन्क्रिप्ट करता है। रहस्य देखें।
  • is_active: false वाला फ़ंक्शन invoke या नौकरियों द्वारा नहीं पाया जाता है।
deploy.shbash
curl -X POST "$AURA_URL/v1/functions" \
  -H "apikey: $AURA_SERVICE_ROLE_KEY" -H "Content-Type: application/json" \
  -d '{"name":"hello","runtime":"deno","code":"Deno.serve(() => new Response(\"ok\"))"}'
#
पुकारना

3.आह्वान करना

POST /v1/functions/{name}/invoke. भूमिका: anon, authenticated या service_role।

मैदानप्रकारगलती करना
methodडोरीPOSTHTTP विधि फ़ंक्शन द्वारा देखी गई
pathडोरी/फ़ंक्शन द्वारा देखा गया पथ
headersवस्तुकोई नहींसमारोह को हेडर दिए गए। आरक्षित शीर्षलेख हटा दिए गए हैं.
bodyकोई भी JSONकोई नहींसमारोह को दिया गया शरीर
हेडर का अनुरोध करें
apikeyआवश्यक
Content-Type: application/jsonआवश्यक
Authorization: Bearer <JWT>वैकल्पिक: उस उपयोगकर्ता के रूप में कॉल करें
X-Aurabase-Invoke-Mode: rawवैकल्पिक: फ़ंक्शन की अपनी प्रतिक्रिया लौटाएँ

डिफ़ॉल्ट प्रतिक्रिया, हमेशा 200:

200json
{ "data": { "status": 200, "headers": { "content-type": "application/json" },
  "body": { "greeting": "Hello, Ada!" }, "logs": [], "duration_ms": 74 }, "meta": null }

status आपके फ़ंक्शन की स्थिति है। logs deno के लिए खाली है। रॉ मोड में प्रतिक्रिया आपके फ़ंक्शन की अपनी होती है: स्थिति, content-type, बाइट्स, प्लस x-aurabase-invoke-origin: function।

असफलतास्थितिerror.code
फ़ंक्शन नहीं मिला या निष्क्रिय404NOT_FOUND
रनटाइम पहुंच योग्य नहीं है503SERVICE_UNAVAILABLE
प्लेटफ़ॉर्म ने रनटाइम की प्रतीक्षा करना बंद कर दिया (timeout_secs प्लस मार्जिन के बाद)504TIMEOUT
योजना कोटा समाप्त हो गया403QUOTA_EXCEEDED
एक ग्राहक से बहुत अधिक कॉलें429rate_limit_exceeded
लगभग 256 KiB से ऊपर का शरीर503SERVICE_UNAVAILABLE
#
पृष्ठभूमि

4. नौकरियाँ और डेड-लेटर कतार

विधि और मार्गभूमिकाशरीर या क्वेरीप्रतिक्रिया
POST /v1/functions/jobsसेवा_भूमिका{ function_name, payload?, delay_secs?, max_attempts? }काम
GET /v1/functions/jobsसेवा_भूमिका?status=&limit= (1 से 500, डिफ़ॉल्ट 50)नौकरियों की श्रृंखला
GET /v1/functions/jobs/{id}सेवा_भूमिकाकोई नहींकाम
POST /v1/functions/jobs/{id}/retryसेवा_भूमिकाकोई नहींनौकरी, pending पर वापस
GET /v1/functions/jobs/dlqसेवा_भूमिका?limit=मृत नौकरियों की श्रृंखला
POST /v1/functions/jobs/dlq/requeueसेवा_भूमिकाकोई नहीं{ "data": { "requeued": 1 } }

कार्य वस्तु: id, project_id, function_name, payload, status (pending, running, completed, failed, dead), attempts, max_attempts, error, scheduled_at, started_at, completed_at, created_at। व्यवहार: जॉब्स, क्रॉन और डेड-लेटर कतार।

#
अनुसूची

5. क्रोन

विधि और मार्गभूमिकाशरीरप्रतिक्रिया
POST /v1/functions/cronसेवा_भूमिका{ name, schedule, function_name, payload? }क्रॉन प्रविष्टि
GET /v1/functions/cronसेवा_भूमिकाकोई नहींप्रविष्टियों की सरणी
DELETE /v1/functions/cron/{name}सेवा_भूमिकाकोई नहीं{ "data": null }, या 404 किसी अज्ञात नाम के लिए

प्रविष्टि: id, project_id, name, schedule (6 फ़ील्ड के साथ संग्रहीत), function_name, payload, is_active, last_run, next_run, created_at।

#
निगरानी करना

6. अलर्ट

विधि और मार्गभूमिकाशरीर या क्वेरी
POST /v1/functions/alertsसेवा_भूमिका{ name, metric, condition, threshold, channel, destination }
GET /v1/functions/alertsसेवा_भूमिकाकोई नहीं
PATCH /v1/functions/alerts/{id}सेवा_भूमिका{ "enabled": true }
DELETE /v1/functions/alerts/{id}सेवा_भूमिकाकोई नहीं
GET /v1/functions/alerts/{id}/eventsसेवा_भूमिका?limit=&offset=
GET /v1/functions/alerts/eventsसेवा_भूमिका?limit=&offset=

मूल्य और व्यवहार: अलर्ट।