مرجع API
برای اسکیمای HTTP قابل خواندن توسط ماشین و ابزار try-it، از مستندات زنده OpenAPI روی API کلودی (رابط Scalar) استفاده کنید. این راهنمای پرتال محصول‌محور است و نشان می‌دهد اتوماسیون چگونه کنار وب‌سایتی که روزانه استفاده می‌کنید قرار می‌گیرد.
API key شخصی را در تنظیمات → API keyها بسازید. دسترسی در هر درخواست اعمال می‌شود (مثلاً clusters:read در برابر clusters:write). برای کار تعاملی با کلاستر، kubeconfig و برای Terraform یا CI کلید API را ترجیح دهید.
آموزش: آماده‌سازی اتوماسیون
ساخت API key محدود
در پرتال به تنظیمات → API keyها → ساخت کلید بروید. حداقل دسترسی لازم را بدهید. رمز را در vault نگه دارید؛ آن را در git، تیکت یا اسکرین‌شات نگذارید.
باز کردن مستندات OpenAPI
از کنترل باز کردن مرجع API در هدر مستندات استفاده کنید، یا مسیر /docs روی میزبان API محیط خود را باز کنید.
فراخوانی API محصولات
منابع رایج شامل کلاستر، منطقه، سایز، VPC، کلید SSH، IP و ولوم است؛ همان محصولاتی که در سایدبار مدیریت می‌کنید.
راهنمای Terraform
نمونه‌های Terraform در مسیر /docs/terraform روی همان میزبان API قرار دارد.
چرخش و ابطال:
با تغییر پایپ‌لاین یا افراد، کلید را باطل کنید. API key زنده را در مستندات عمومی نگذارید.