کلیدِ API

با کلیدِ API می‌توانید از اسکریپت، CI، داشبوردِ خودتان یا یک ایجنتِ هوش مصنوعی با سازمان کار کنید. فهرستِ endpointها و نمونه‌ها در API: endpointها است. ساختِ منبع از راهِ API به‌زودی اضافه می‌شود.

ساختِ کلید#

1. SETTINGS → API KEYS (owner یا admin).
2. یک نام بدهید — مثلاً ci-deploy.
3. انقضا را انتخاب کنید: ۳۰، ۹۰ (پیش‌فرض) یا ۳۶۵ روز، یا بدونِ انقضا.
4. دسترسی‌ها (scopes) را انتخاب کنید. فقط همان چیزی را بدهید که کلید لازم دارد:

5. سقفِ ساخت در روز: هر کلید روزانه حداکثر همین تعداد منبع می‌سازد (پیش‌فرض ۵). admin فقط می‌تواند کمترش کند؛ بیشتر از ۵ را فقط owner تنظیم می‌کند. این جلوی اسکریپت یا ایجنتی را می‌گیرد که اشتباهی در حلقه منبع بسازد.
6. کلید فقط همین یک بار نمایش داده می‌شود؛ همان لحظه در جای امن ذخیره‌اش کنید.

کلیدهایی که پیش از اضافه شدنِ دسترسی‌ها ساخته شده‌اند فقط read دارند و منقضی نمی‌شوند. در فهرستِ کلیدها، آخرین زمانِ استفاده هم دیده می‌شود (owner آی‌پی را هم می‌بیند).

برای باطل‌کردن، کنارِ کلید REVOKE را بزنید؛ اسکریپت‌هایی که از آن استفاده می‌کنند فوراً قطع می‌شوند.

فراخوانی#

curl -s https://console.weblines.ir/api/v1/resources \
  -H "Authorization: Bearer $WEBLINES_API_KEY"

پاسخِ نمونه:

{
  "ok": true,
  "resources": [
    {
      "id": "cm…",
      "type": "app",
      "name": "api",
      "status": "running",
      "catalogKey": "custom-app",
      "cpuMillicores": 500,
      "memoryMb": 1024,
      "diskGb": 5,
      "createdAt": "2026-09-30T08:00:00.000Z"
    }
  ]
}

خطاها#

همه‌ی خطاها به یک شکل‌اند:

{ "ok": false, "error": { "code": "unauthorized", "message": "Missing, invalid or expired API key" } }

امنیت#

• کلید را در گیت commit نکنید؛ در secretِ CI نگه دارید.
• برای هر کاربرد یک کلیدِ جدا بسازید تا بتوانید تک‌تک باطلشان کنید.
• کمترین scope و کوتاه‌ترین انقضای ممکن را انتخاب کنید.
• کارهایی که با کلید چیزی را تغییر می‌دهند (دیپلوی، ساخت، حذف) در SETTINGS → ACTIVITY با نامِ کلید دیده می‌شوند. خواندن ثبت نمی‌شود؛ آخرین زمانِ استفاده در فهرستِ کلیدهاست.