Skip to main content
GET
/
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.retrieve(
  '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);

console.log(trafficPolicyProfile.data);
import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
traffic_policy_profile = client.traffic_policy_profiles.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(traffic_policy_profile.data)
package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	trafficPolicyProfile, err := client.TrafficPolicyProfiles.Get(context.TODO(), "6a09cdc3-8948-47f0-aa62-74ac943d6c58")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", trafficPolicyProfile.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.trafficpolicyprofiles.TrafficPolicyProfileRetrieveParams;
import com.telnyx.sdk.models.trafficpolicyprofiles.TrafficPolicyProfileRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        TrafficPolicyProfileRetrieveResponse trafficPolicyProfile = client.trafficPolicyProfiles().retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58");
    }
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

traffic_policy_profile = telnyx.traffic_policy_profiles.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(traffic_policy_profile)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $trafficPolicyProfile = $client->trafficPolicyProfiles->retrieve(
    '6a09cdc3-8948-47f0-aa62-74ac943d6c58'
  );

  var_dump($trafficPolicyProfile);
} catch (APIException $e) {
  echo $e->getMessage();
}
telnyx traffic-policy-profiles retrieve \
  --api-key 'My API Key' \
  --id 6a09cdc3-8948-47f0-aa62-74ac943d6c58
curl --request GET \
  --url https://api.telnyx.com/v2/traffic/policy/profiles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}
{
  "code": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "source": {
    "pointer": "<string>",
    "parameter": "<string>"
  },
  "meta": {}
}
{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

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"

Response

Successful Response

​
data
object