حذف یک نتورک

دستور delete برای حذف کردن یک نتورک استفاده می‌شود.

🧩 دستور کلی

{{baseURL}}/networks/{{networkName}}/delete

---

📥 مشخصات درخواست (Request)

فیلد	مقدار
Method	DELETE
Endpoint	/networks/{{networkName}}/delete
Query Parameters	خیر
Content-Type	application/json

---

⚙️ پارامترها (params)

---

بدنه (body)

فیلد	نوع داده	توضیح
force	true, false	optional, default=false

---

فیلدهای ورودی (Options)

---

مثال کامل‌تر:

---

روش استفاده (How to Use)

مثال ۱:

DELETE {{baseURL}}/networks/my-br3/delete

نمونه response:

{
    "meta": {
        "shamsiDate": "14040518135530454",
        "requestId": "4b0004f6-f082-42c5-88e0-2bd39dbefea1"
    },
    "data": {
        "message": "Network my-br3 deleted successfully",
        "data": {
            "id": "1a3e8d7c34f84e0c",
            "name": "my-br3",
            "driver": "bridge",
            "networkIF_name": "kb-1a3e8d7c34f8",
            "options": {},
            "IPAM": {
                "options": {},
                "configs": {
                    "subnet": "192.167.0.0/16",
                    "gateway": "192.167.210.14/16"
                }
            },
            "containers": {}
        }
    }
}

مثال ۲:

DELETE {{baseURL}}/networks/kb2/delete

نمونه response:

{
    "data": {
        "message": "Network interface kb2 doesn't exist"
    },
    "meta": {
        "code": "unknown",
        "sourceType": "unknown",
        "sourceName": "unknown",
        "version": "unknown",
        "shamsiDate": "14040518134257008",
        "requestId": "12808fa8-e442-4c25-aafb-81bf7bff48ca"
    }
}

مثال ۳:

DELETE {{baseURL}}/networks/kb2/delete
{
    "force": true
}

نمونه response:

{
    "meta": {
        "shamsiDate": "14040518140452658",
        "requestId": "125a01cd-bedc-4d5d-a09f-90c1f3ea88d1"
    },
    "data": {
        "message": "Network kb0 deleted successfully",
        "data": {
            "id": "0d876d2b6234a857",
            "name": "kb0",
            "driver": "bridge",
            "networkIF_name": "kb0",
            "options": {},
            "IPAM": {
                "options": {},
                "configs": {
                    "subnet": "192.168.100.0/24",
                    "gateway": "192.168.100.254/24"
                }
            },
            "containers": {
                "47cd82f8e285bc86": {
                    "name": "cont1",
                    "MacAddress": "46:CD:82:F8:E2:85",
                    "IPv4Address": "192.168.100.2/24"
                }
            }
        }
    }
}

---

وضعیت‌ پاسخ (Status Codes)

کد	معنی
200 OK	درخواست با موفقیت انجام شد
400 BAD REQUEST	مثال:‌نتورک داده شده وجود ندارد

---

نکات مهم

درصورتی که کانتینری وجود داشته باشد که از نتورک ما استفاده کند بایستی از force برای

⚙️ خطاهای رایج

1. Network interface network-name doesn't exist
2. The network-name network cannot be deleted. Use --force

---

🆘 دریافت راهنما

---