لیست نتورک

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

🧩 دستور کلی

{{baseURL}}/networks/list

---

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

فیلد	مقدار
Method	GET
Endpoint	/networks/list
Query Parameters	بله
Content-Type	application/json

---

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

فیلد	مقدار	توضیحات
verbose	true, false	درصورت true بودن همانند inspect عمل میکند default=false
quiet	true, false	در صورت true بودن فقط network id خروجی داده میشود default=false
dangling	true, false, all	درصورتی که true باشد فقط network هایی که هیچ کانتینری از آنها استفاده نمیکند نشان داده میشوند. default=all
onlyIFs	true, false	درصورت true بودن فقط لیست interface های مربوط به آن network خروجی داده میشوند. default=false

---

---

بدنه (body)

ندارد

---

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

---

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

---

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

مثال ۱:

POST {{baseURL}}/networks/list

نمونه response:

{
    "meta": {
        "shamsiDate": "14040518124047854",
        "requestId": "4c3a9517-3467-4961-a330-abb706b030dc"
    },
    "data": [
        {
            "id": "0d876d2b6234a857",
            "name": "kb0",
            "driver": "bridge"
        },
        {
            "id": "a294dc4a4e6f7f94",
            "name": "macnet1",
            "driver": "macvlan"
        },
        {
            "id": "1a3e8d7c34f84e0c",
            "name": "my-br3",
            "driver": "bridge"
        }
    ]
}

مثال ۲:

POST {{baseURL}}/networks/list?verbose=true&driver=macvlan

نمونه response:

{
    "meta": {
        "shamsiDate": "14040518124311093",
        "requestId": "528e6611-1ca1-4229-9d77-2c7b3c537f26"
    },
    "data": [
        {
            "id": "a294dc4a4e6f7f94",
            "name": "macnet1",
            "driver": "macvlan",
            "options": {
                "parent": "ens33",
                "vlanId": 15,
                "bridgeIF_name": "kb-1265f71c2bc5"
            },
            "IPAM": {
                "options": {},
                "configs": {
                    "subnet": "192.168.101.0/24",
                    "gateway": "192.168.101.254/24"
                }
            },
            "containers": {}
        }
    ]
}

مثال ۳:

POST {{baseURL}}/networks/list?onlyIFs=true

نمونه response:

{
    "meta": {
        "shamsiDate": "14040518124536988",
        "requestId": "be1cf304-5acf-4d19-b233-081b10bb62a9"
    },
    "data": [
        {
            "name": "kb0",
            "interfaces": [
                "kb0"
            ]
        },
        {
            "name": "macnet1",
            "interfaces": [
                "macnet1.15",
                "kb-1265f71c2bc5"
            ]
        },
        {
            "name": "my-br3",
            "interfaces": [
                "kb-1a3e8d7c34f8"
            ]
        }
    ]
}

مثال ۴:

POST {{baseURL}}/networks/list?quiet=true

نمونه response:

{
    "meta": {
        "shamsiDate": "14040518124627456",
        "requestId": "0637c9b2-e191-4be5-9046-554abe56d808"
    },
    "data": [
        {
            "id": "0d876d2b6234a857"
        },
        {
            "id": "a294dc4a4e6f7f94"
        },
        {
            "id": "1a3e8d7c34f84e0c"
        }
    ]
}

---

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

کد	معنی
200 OK	درخواست با موفقیت انجام شد

---

نکات مهم

اولویت Query Paramaters:

1. quiet
2. onlyIFs
3. verbose

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

---

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

---