مرجع اندپوینت‌ها

در این صفحه فهرست اندپوینت‌های API داده‌هات به تفکیک منبع آمده است. مسیرها نسبت به نشانی پایه‌ی https://api.dadehat.com/api/v1 نوشته شده‌اند و ستون «دسترسی» حداقل Scope لازم برای توکن را نشان می‌دهد.

نکات کلی

در درخواست‌های فهرست، شناسه‌ی پروژه را با پارامتر project_id ارسال کنید؛ مانند GET /vms?project_id=<PROJECT_ID>. در برخی مسیرها، شناسه‌ی پروژه بخشی از خود مسیر است.
دسترسی write شامل read نیز می‌شود.
درخواست‌هایی که منبعی را می‌سازند، تغییر می‌دهند یا حذف می‌کنند، به حساب احراز هویت‌شده نیاز دارند.
ساخت، تغییر و حذف بیش‌تر منابع از طریق عملیات‌ها (Actions) انجام می‌شود و در جدول‌های زیر فقط مسیرهای مستقیم آمده است.

عملیات‌ها

متد	مسیر	توضیح	دسترسی
GET	/actions	فهرست عملیات‌ها با صفحه‌بندی و فیلتر	read منبع مربوط
POST	/actions	آغاز یک عملیات	write منبع مربوط
GET	/actions/{action_id}	جزئیات و وضعیت یک عملیات	read منبع مربوط
POST	/actions/{action_id}/cancel	لغو عملیات	write منبع مربوط

پروژه

متد	مسیر	توضیح	دسترسی
GET	/projects	فهرست پروژه‌ها	project:read
GET	/projects/{project_id}	جزئیات پروژه، از جمله tenant_id و ناحیه	project:read
PUT	/projects/{project_id}	ویرایش نام و توضیحات پروژه	project:write
GET	/projects/{project_id}/members	فهرست اعضای پروژه و نقش آن‌ها	project:read

سرور

متد	مسیر	توضیح	دسترسی
GET	/vms/base-images	فهرست ایمیج‌های سیستم‌عامل	توکن معتبر
GET	/vms/types	فهرست پلن‌های سرور	توکن معتبر
GET	/vms	فهرست سرورهای پروژه	vm:read
GET	/vms/{vm_id}	جزئیات سرور	vm:read
PATCH	/vms/{vm_id}	تغییر نام سرور	vm:write

کلیدهای SSH

متد	مسیر	توضیح	دسترسی
GET	/ssh-keys	فهرست کلیدهای SSH پروژه	ssh-key:read
POST	/ssh-keys	افزودن کلید SSH	ssh-key:write
GET	/ssh-keys/{key_id}	جزئیات کلید SSH	ssh-key:read
DELETE	/ssh-keys/{key_id}	حذف کلید SSH	ssh-key:write

والیوم

متد	مسیر	توضیح	دسترسی
GET	/volumes	فهرست والیوم‌های پروژه	volume:read
GET	/volumes/{volume_id}	جزئیات والیوم	volume:read

اسنپ‌شات

متد	مسیر	توضیح	دسترسی
GET	/snapshots	فهرست اسنپ‌شات‌ها	snapshot:read
GET	/snapshots/{snapshot_id}	جزئیات اسنپ‌شات	snapshot:read
GET	/snapshot-schedules	فهرست زمان‌بندی‌های اسنپ‌شات	snapshot:read
POST	/snapshot-schedules	ساخت زمان‌بندی برای یک والیوم	snapshot:write
PATCH	/snapshot-schedules/{schedule_id}	ویرایش، غیرفعال‌سازی یا از سرگیری زمان‌بندی	snapshot:write
DELETE	/snapshot-schedules/{schedule_id}	حذف زمان‌بندی	snapshot:write

شبکه

متد	مسیر	توضیح	دسترسی
GET	/vpcs	فهرست ابرهای خصوصی	network:read
POST	/vpcs	ساخت ابر خصوصی	network:write
GET	/vpcs/{vpc_id}	جزئیات ابر خصوصی	network:read
GET	/vpcs/{vpc_id}/subnets	فهرست ساب‌نت‌های ابر خصوصی	network:read
GET	/vpcs/{vpc_id}/suggest-subnet	پیشنهاد یک محدوده‌ی آزاد /24 برای ساب‌نت جدید	network:read
GET	/subnets/{subnet_id}	جزئیات ساب‌نت	network:read
GET	/vpcs/{vpc_id}/internet-gateway	وضعیت اینترنت گیت‌وی ابر خصوصی	network:read
DELETE	/vpcs/{vpc_id}/internet-gateway	غیرفعال‌سازی اینترنت گیت‌وی	network:write
GET	/security-groups	فهرست گروه‌های امنیتی	network:read
POST	/security-groups	ساخت گروه امنیتی همراه با قوانین	network:write
GET	/security-groups/{sg_id}	جزئیات و قوانین گروه امنیتی	network:read
PUT	/security-groups/{sg_id}	جایگزینی قوانین گروه امنیتی	network:write
DELETE	/security-groups/{sg_id}	حذف گروه امنیتی	network:write
GET	/elastic-ips	فهرست آی‌پی‌های الستیک	network:read
GET	/elastic-ips/{elastic_ip_id}	جزئیات آی‌پی الستیک	network:read
GET	/load-balancers	فهرست توزیع‌کننده‌های بار	network:read
GET	/load-balancers/{load_balancer_id}	جزئیات توزیع‌کننده‌ی بار	network:read

کانتینر

متد	مسیر	توضیح	دسترسی
GET	/containers/plans	فهرست پلن‌های کانتینر	توکن معتبر
GET	/containers	فهرست کانتینرهای پروژه	container:read
GET	/containers/{container_id}	جزئیات کانتینر	container:read
GET	/containers/{container_id}/logs	لاگ‌های اخیر کانتینر	container:read
GET	/containers/{container_id}/revisions	تاریخچه‌ی نسخه‌های کانتینر	container:read
GET	/containers/{container_id}/exec	اتصال WebSocket به ترمینال کانتینر	container:write

رجیستری

مسیرهای رجیستری با پیشوند /registry آغاز می‌شوند.

متد	مسیر	توضیح	دسترسی
GET	/registry/projects/{project_id}/registries	فهرست رجیستری‌های پروژه	registry:read
POST	/registry/projects/{project_id}/registries	ساخت رجیستری	registry:write
GET	/registry/registries/{registry_id}	جزئیات رجیستری و میزان مصرف	registry:read
DELETE	/registry/registries/{registry_id}	حذف رجیستری و تمام ایمیج‌های آن	registry:write
PUT	/registry/registries/{registry_id}/quota	تغییر سقف فضای ذخیره‌سازی	registry:write
GET	/registry/registries/{registry_id}/repositories	فهرست مخزن‌ها	registry:read
GET	/registry/registries/{registry_id}/repositories/{repo}/artifacts	فهرست ایمیج‌ها و تگ‌های یک مخزن	registry:read
DELETE	/registry/registries/{registry_id}/repositories/{repo}	حذف مخزن	registry:write
DELETE	/registry/registries/{registry_id}/repositories/{repo}/artifacts/{reference}	حذف یک ایمیج	registry:write
DELETE	/registry/registries/{registry_id}/repositories/{repo}/artifacts/{reference}/tags/{tag}	حذف یک تگ	registry:write
GET	/registry/registries/{registry_id}/audit	فهرست رویدادهای Push و حذف	registry:read
GET	/registry/registries/{registry_id}/retention	مشاهده‌ی سیاست نگه‌داری	registry:read
PUT	/registry/registries/{registry_id}/retention	تنظیم سیاست نگه‌داری	registry:write
POST	/registry/registries/{registry_id}/retention/dry-run	اجرای آزمایشی سیاست نگه‌داری	registry:read
POST	/registry/registries/{registry_id}/retention/run	اجرای فوری سیاست نگه‌داری	registry:write
GET	/registry/registries/{registry_id}/retention/executions	فهرست اجراهای سیاست نگه‌داری	registry:read
GET	/registry/registries/{registry_id}/retention/executions/{execution_id}/log	لاگ یک اجرا	registry:read
GET	/registry/credentials	فهرست کلیدهای دسترسی رجیستری	registry:read
POST	/registry/credentials	ساخت کلید دسترسی (Pull یا Push و Pull)	registry:write
DELETE	/registry/credentials/{credential_id}	ابطال کلید دسترسی	registry:write

بیلد و دپلوی

متد	مسیر	توضیح	دسترسی
GET	/build/connections	فهرست حساب‌های متصل GitHub و GitLab	build:read
GET	/build/repos	فهرست مخزن‌های قابل دسترس	build:read
GET	/build/rules	فهرست قانون‌های بیلد	build:read
POST	/build/rules	ساخت قانون بیلد	build:write
PUT	/build/rules/{rule_id}	ویرایش قانون بیلد	build:write
DELETE	/build/rules/{rule_id}	حذف قانون بیلد	build:write
GET	/build/runs	فهرست بیلدها	build:read
GET	/build/runs/{run_id}	جزئیات یک بیلد	build:read
GET	/build/runs/{run_id}/logs	لاگ یک بیلد	build:read

اجرای دستی بیلد با فرمان build.trigger در عملیات‌ها انجام می‌شود.

بازارچه

متد	مسیر	توضیح	دسترسی
GET	/apps/catalog	فهرست اپلیکیشن‌های بازارچه	app:read
GET	/apps/catalog/{catalog_id}	جزئیات یک اپلیکیشن، نسخه‌ها و فرم تنظیمات	app:read
GET	/apps	فهرست اپلیکیشن‌های نصب‌شده در پروژه	app:read
GET	/apps/{app_id}	جزئیات اپلیکیشن نصب‌شده	app:read
GET	/apps/{app_id}/credentials	اطلاعات ورود اپلیکیشن	app:write

نصب و حذف اپلیکیشن با فرمان‌های app.deploy و app.delete در عملیات‌ها انجام می‌شود.

فضای ابری

متد	مسیر	توضیح	دسترسی
GET	/buckets	فهرست باکت‌های پروژه	bucket:read
POST	/buckets	ساخت باکت با project_id و name	bucket:write
GET	/buckets/{bucket_id}	جزئیات و میزان مصرف باکت	bucket:read
DELETE	/buckets/{bucket_id}	حذف باکت؛ برای حذف باکت دارای آبجکت، ?force=true را اضافه کنید.	bucket:write
PUT	/buckets/{bucket_id}/quota	تعیین سقف حجم با quota_gb؛ مقدار 0 سقف را حذف می‌کند.	bucket:write
PUT	/buckets/{bucket_id}/settings	تنظیم نسخه‌بندی و مبدأهای CORS	bucket:write
GET	/buckets/{bucket_id}/objects	فهرست آبجکت‌ها با پارامترهای prefix و continuation	bucket:read
POST	/buckets/{bucket_id}/presign	ساخت نشانی امضاشده‌ی موقت (حداکثر ۱۵ دقیقه)	bucket:write
GET	/buckets/credentials	فهرست کلیدهای S3	bucket:read
POST	/buckets/credentials	ساخت کلید S3	bucket:write
DELETE	/buckets/credentials/{credential_id}	ابطال کلید S3	bucket:write
GET	/buckets/endpoint	نشانی و ناحیه‌ی S3 پروژه	bucket:read

برای کار با آبجکت‌ها در حجم بالا، پیشنهاد می‌شود به‌جای این مسیرها از ابزارهای سازگار با S3 استفاده کنید. راهنمای اتصال با ابزارهای S3 را ببینید.

قیمت‌ها

متد	مسیر	توضیح	دسترسی
GET	/pricing	نرخ فعلی هر منبع شامل واحد و مبلغ به تومان	توکن معتبر