> This page is for Harmonic.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Get pools

GET https://device.example.com:443/cluster1/vos-api/configure/v1/pools

List divitrack pools in the system.

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/configure-pool/get-pools

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `name` (string, optional) — Filter by name
- `label` (string, optional) — Filter by label
- `skip` (integer, optional) — Skip N records
- `top` (integer, optional) — Top first M records

## Response

### 200

Success

- `list of com.harmonicinc.vos.app.configure.model.pool.Pool`

## Errors

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Not Found

- `any`

## Types

### com.harmonicinc.vos.app.configure.model.pool.Pool

- `divitrackIP` (string, optional) — IP address for the divitrack rate message
- `divitrackIpNetworkAddress` (string, optional) — Interface address for sending and receiving divitrack messages
- `divitrackPoolBitrate` (integer, optional) — Bitrate for the divitrack pool in bps
- `divitrackPoolId` (integer, optional) — Divitrack pool id
- `divitrackPoolLatencyMode` (enum, optional) — Latency mode for a divitrack pool
  - Allowed values: `DEFAULT`, `REDUCED`, `EXTENDED`
- `divitrackPort` (integer, optional) — Port for the divitrack rate message
- `downstreamComplexityIpDelay` (integer, optional) — Network delay for the downstream complexity message
- `downstreamIpDelay` (integer, optional) — Downstream network delay
- `id` (string, optional) — Unique identifier of a pool. If specified, pool source will not be created automatically (not applicable for /mux/v1/services API).
- `labels` (list of string, optional) — Labels attached to a pool for identification
- `maxSourcesDelay` (integer, optional) — Maximum sources delay
- `muxAddress` (list of string, optional) — IP addresses of the mux
- `name` (string, optional) — Display name of a pool
- `poolMode` (enum, optional) — Rate mode for the pool
  - Allowed values: `VBR`, `CBR`
- `stcIp` (string, optional) — IP address for the divitrack STC message
- `stcPort` (integer, optional) — Port for the divitrack STC message
- `upstreamIpDelay` (integer, optional) — Upstream network delay
- `useNominalBitrate` (boolean, optional) — Use the provisioned nominal bitrate by user in destination object. If this value is false or absent, nominal bitrate will be determined automatically. (For internal use)

## Examples

**Response**

```json
[
  {
    "divitrackIP": "string",
    "divitrackIpNetworkAddress": "string",
    "divitrackPoolBitrate": 1,
    "divitrackPoolId": 1,
    "divitrackPoolLatencyMode": "DEFAULT",
    "divitrackPort": 1,
    "downstreamComplexityIpDelay": 1,
    "downstreamIpDelay": 1,
    "id": "string",
    "labels": [
      "string"
    ],
    "maxSourcesDelay": 1,
    "muxAddress": [
      "string"
    ],
    "name": "string",
    "poolMode": "VBR",
    "stcIp": "string",
    "stcPort": 1,
    "upstreamIpDelay": 1,
    "useNominalBitrate": true
  }
]
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/pools"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/configure/v1/pools';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/configure/v1/pools"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/configure/v1/pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://device.example.com/cluster1/vos-api/configure/v1/pools")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://device.example.com/cluster1/vos-api/configure/v1/pools', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/pools");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/pools")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```