API: بازار اپلیکیشن

مرور اپلیکیشن‌ها و نصب یکی روی ماشین در حال اجرا.

مرور کاتالوگ عمومی است. نصب ناهمگام است: آن را شروع کنید و سپس فهرست استقرار ماشین را بپرسید.

فهرست اپلیکیشن‌ها

GET /appmarket/apps

کاتالوگ بازار اپلیکیشن را برمی‌گرداند. با category یا target فیلتر کنید.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پارامترهای query

فیلد	نوع	مقادیر
`category`	string	`vpn_proxy`, `dev_tools`, `framework_starter`
`target`	string	`vm`

پاسخ‌ها

200 موفق. برمی‌گرداند: data (فهرستی از AppCatalogEntry).

نمونه

curl -X GET https://veneshcloud.ir/api/appmarket/apps \
  -H "Accept: application/json"

دریافت یک اپلیکیشن

GET /appmarket/apps/{appCatalogEntry}

یک اپلیکیشن را با slug آن برمی‌گرداند.

احراز هویت: ندارد، این نقطهٔ پایانی عمومی است.

پارامترهای مسیر

فیلد	نوع
`appCatalogEntry`	string

پاسخ‌ها

200 موفق. برمی‌گرداند: data (AppCatalogEntry).
404 پیدا نشد

نمونه

curl -X GET https://veneshcloud.ir/api/appmarket/apps/APP_SLUG \
  -H "Accept: application/json"

فهرست استقرارها روی یک ماشین

GET /orders/{order}/apps/deployments

تاریخچه و وضعیت استقرارهای ماشین را برمی‌گرداند.

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پارامترهای مسیر

فیلد	نوع
`order`	integer

پاسخ‌ها

200 موفق. برمی‌گرداند: data (فهرستی از AppDeployment).
403 مجاز نیست، این منبع متعلق به شما نیست

نمونه

curl -X GET https://veneshcloud.ir/api/orders/ORDER_ID/apps/deployments \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

نصب یک اپلیکیشن

POST /orders/{order}/apps/{appCatalogEntry}/deploy

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

احراز هویت: کلید API یا توکن خود را به‌صورت Bearer بفرستید.

پارامترهای مسیر

فیلد	نوع
`order`	integer
`appCatalogEntry`	string

بدنهٔ درخواست (application/json)

فیلد	نوع	الزامی	مقادیر
`operation_id`	string	خیر

پاسخ‌ها

200 موفق. برمی‌گرداند AppDeployment.
403 مجاز نیست، این منبع متعلق به شما نیست
422 خطای اعتبارسنجی یا مجاز نبودن در وضعیت فعلی

نمونه

curl -X POST https://veneshcloud.ir/api/orders/ORDER_ID/apps/APP_SLUG/deploy \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

اشیاء

فهرست فیلدهای اشیایی که در بالا برگردانده می‌شوند.

AppCatalogEntry

فیلد	نوع	مقادیر
`id`	integer
`slug`	string
`name`	string
`category`	string	`vpn_proxy`, `dev_tools`, `framework_starter`
`target`	string	`vm`
`description`	string
`logo_url`	string

AppDeployment

فیلد	نوع	مقادیر
`id`	integer
`order_id`	integer
`app`	`AppCatalogEntry`
`operation_id`	string
`status`	string	`queued`, `running`, `succeeded`, `failed`
`output`	string
`failure_reason`	string
`started_at`	string
`finished_at`	string
`created_at`	string