کلیدِ API

با کلیدِ API می‌توانید فهرستِ منابعِ سازمان و وضعیتشان را از اسکریپت، CI یا داشبوردِ خودتان بخوانید. API فعلاً فقط‌خواندنی است.

ساختِ کلید#

1. SETTINGS → API KEYS (owner یا admin).
2. یک نام بدهید — مثلاً ci-status — و کلید را بسازید.
3. کلید فقط همین یک بار نمایش داده می‌شود؛ همان لحظه در جای امن ذخیره‌اش کنید.

برای باطل‌کردن، کنارِ کلید 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"
    }
  ]
}

کلیدِ نامعتبر یا باطل‌شده پاسخِ 401 می‌گیرد.

امنیت#

• کلید را در گیت commit نکنید؛ در secretِ CI نگه دارید.
• برای هر کاربرد یک کلیدِ جدا بسازید تا بتوانید تک‌تک باطلشان کنید.