# VM IP pools

`GET /v1/service/@id/vms/@vmid/ippool` · scope `services:read`

IP pools for a network interface or a network bridge.

## HTTP request

| Item | Value |
| --- | --- |
| URL | `https://api.tino.vn/v1/service/@id/vms/@vmid/ippool` |
| Method | `GET` |
| Scope | `services:read` |
| Header | `Authorization: Bearer <token>` |
| Content-Type | — (no body) |
| Tokens that can call it | app tokens (`tinoat_`), personal API tokens (`tinopat_`) |

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string | yes | Service ID |
| `vmid` | path | string | yes | Virtual machine ID |
| `Name` | undefined | Type | no | Description |
| `---` | undefined | --- | no | --- |
| `iface` | query | integer | no | Interface number [optional] |
| `bridge` | query | string | no | Bridge name [optional, ignored if interface provided] |

## Example request

```bash
curl "https://api.tino.vn/v1/service/100001/vms/600001/ippool" \
  -H "Authorization: Bearer $TINO_TOKEN"
```

`$TINO_TOKEN` is a token with the scope `services:read`. Path parameters in the example are sample values.

SDK ([SDK & examples](/en/docs/sdk)): Python `client.vms.list_ip_pools(id, vmid)`, Node.js `await client.vms.listIpPools(id, vmid);`, PHP `$client->vms->listIpPools($id, $vmid);`.

## Example response

```json
[
 {
  "id": "public",
  "name": "Public IP(s)",
  "type": "ipv4",
  "vlan_id": "41",
  "firstip": "203.0.113.10",
  "mask": "/24",
  "gateway": "203.0.113.10"
 },
 {
  "id": "public",
  "name": "Public IP(s)",
  "type": "ipv6",
  "vlan_id": "42",
  "firstip": "2001:db8::",
  "mask": "/64",
  "gateway": "2001:db8::1"
 }
]
```

Live sample from a test account with personal data masked; long arrays and strings are trimmed (`… N more item(s)`, `… N more line(s)`).