پرش به مطلب اصلی

ذخیره‌ی اتصال بیرونی تازه

POST 
/api/v1/IOService/ExternalFs/Connections

یک اتصال بیرونی تازه را با تنظیمات و اطلاعات محرمانه‌ی آن ذخیره می‌کند. اطلاعات محرمانه رمزگذاری‌شده نگه‌داری می‌شوند.

دسترسی: کاربر واردشده با Authorization و x-container (مقدار container که GET /api/v1/services/current برمی‌گرداند). اتصال‌ها و انتقال‌ها فقط برای همان کاربر دیده می‌شوند.

بدنه‌ی درخواست: name، provider (مثلاً SFTP)، config (طبق configSchema)، secrets (طبق secretSchema). فرستادن secrets اختیاری است؛ اطلاعات محرمانه‌ی لازمی که ذخیره نشود، هنگام استفاده از اتصال پرسیده می‌شود.

پاسخ: 201 با اتصال ساخته‌شده.

خطاها: 400 یا 422 برای تنظیمات نامعتبر یا نوع اتصال غیرفعال؛ 429 با LIMIT_REACHED وقتی سقف تعداد اتصال‌ها پر شده است.

نکته: این قابلیت باید روی سرور روشن باشد (در غیر این صورت 404 با کد NOT_FOUND) و برای این کاربر هم فعال شده باشد (در غیر این صورت 403 با کد NOT_ENABLED). خطاها به شکل { error, code, detail } برمی‌گردند. اگر مجوز این گره قابلیت external.connect را اجازه ندهد، پاسخ 402 با کد LICENCE_RESTRICTED است.

درخواست​

پاسخ‌ها​

OK