Skip to main content
GET
/
traffic
/
policy
/
profiles
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const trafficPolicyProfile of client.trafficPolicyProfiles.list()) {
  console.log(trafficPolicyProfile.id);
}
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "traffic_policy_profile",
      "type": "whitelist",
      "services": [
        "service_123",
        "service_456"
      ],
      "ip_ranges": [
        "10.64.0.0/24",
        "10.64.0.0/25"
      ],
      "domains": [
        "www.hbomax.com",
        "netflix.com"
      ],
      "limit_bw_kbps": 512,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page[number]
integer
default:1

The page number to load.

Required range: x >= 1
​
page[size]
integer
default:20

The size of the page.

Required range: 1 <= x <= 250
​
filter[type]
enum<string>

Filter by traffic policy profile type.

Available options:
whitelist,
blacklist,
throttling
​
filter[service]
string

Filter by service ID.

​
sort
enum<string>

Sorts traffic policy profiles by the given field. Defaults to ascending order unless field is prefixed with a minus sign.

Available options:
service,
-service,
type,
-type

Response

Successful Response

​
data
object[]
​
meta
object