پرش به محتوای اصلی
همه چیز در حال کار است
آغاز محتوای اصلی
بازگشت به مستندات

vm-firewall

4 endpoint

GET /api/v1/vms/{uuid}/firewall scope: vm:firewall:read

Get firewall state

پارامترهای مسیر
  • uuidVM UUID
پاسخ‌ها
  • 200Enabled flag + rule list
نمونه cURL
curl -X GET -H "Authorization: Bearer ic_pat_…" \
  https://iranclaud.ir/api/v1/vms/{uuid}/firewall
POST /api/v1/vms/{uuid}/firewall/rules scope: vm:firewall:write

Add a firewall rule

پارامترهای مسیر
  • uuidVM UUID
بدنه درخواست (JSON)
{
    "proto": "tcp",
    "port": "443",
    "source": "0.0.0.0/0",
    "comment": "HTTPS"
}
پاسخ‌ها
  • 201Rule created
نمونه cURL
curl -X POST -H "Authorization: Bearer ic_pat_…" \
  -H "Content-Type: application/json" \
    -d '{"proto":"tcp","port":"443","source":"0.0.0.0/0","comment":"HTTPS"}' \
  https://iranclaud.ir/api/v1/vms/{uuid}/firewall/rules
DELETE /api/v1/vms/{uuid}/firewall/rules/{pos} scope: vm:firewall:write

Remove a firewall rule

پارامترهای مسیر
  • uuidVM UUID
  • posRule position
پاسخ‌ها
  • 204Removed
نمونه cURL
curl -X DELETE -H "Authorization: Bearer ic_pat_…" \
  https://iranclaud.ir/api/v1/vms/{uuid}/firewall/rules/{pos}
POST /api/v1/vms/{uuid}/firewall/toggle scope: vm:firewall:write

Enable/disable the firewall

پارامترهای مسیر
  • uuidVM UUID
بدنه درخواست (JSON)
{
    "enabled": true
}
پاسخ‌ها
  • 200New enabled state
نمونه cURL
curl -X POST -H "Authorization: Bearer ic_pat_…" \
  -H "Content-Type: application/json" \
    -d '{"enabled":true}' \
  https://iranclaud.ir/api/v1/vms/{uuid}/firewall/toggle