Skip to main content
PATCH
/
traffic
/
policy
/
profiles
/
{id}
JavaScript
import Telnyx from 'telnyx';

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

const trafficPolicyProfile = await client.trafficPolicyProfiles.update(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);

console.log(trafficPolicyProfile.data);
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Identifies the traffic policy profile.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Body

application/json
​
type
enum<string>

The type of the traffic policy profile.

Available options:
whitelist,
blacklist,
throttling
Example:

"whitelist"

​
services
string[]

Array of PCEF service IDs to include in the profile.

Example:
["service_123"]
​
ip_ranges
string[]

Array of IP ranges in CIDR notation.

Example:
["10.64.0.0/24"]
​
domains
string[]

Array of domain names.

Example:
["netflix.com"]
​
limit_bw_kbps
enum<integer> | null

Bandwidth limit in kbps. Must be 512 or 1024, or null to remove.

Available options:
512,
1024,
null
Example:

1024

Response

Successful Response

​
data
object