PingOne Platform APIs

Read Inbound Traffic Policies

 

GET {{apiPath}}/environments/{{envID}}/inboundTrafficPolicies

The GET /environments/{{envID}}/inboundTrafficPolicies endpoint returns the list of inbound traffic policy configurations associated with the specified environment.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
GET /environments/{{envID}}/inboundTrafficPolicies HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/inboundTrafficPolicies")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/inboundTrafficPolicies"
        }
    },
    "_embedded": {
        "inboundTrafficPolicies": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/inboundTrafficPolicies/278b8b5f-882f-418a-875b-d8e5d77758ec"
                    }
                },
                "id": "278b8b5f-882f-418a-875b-d8e5d77758ec",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Sample Test Connection Config",
                "enabled": true,
                "priority": 100,
                "clientIpRule": {
                    "type": "HEADER_CSV",
                    "name": "x-custom-header",
                    "index": 1,
                    "cardinality": 3
                },
                "headerRules": [
                    {
                        "name": "content-policy",
                        "required": true
                    },
                    {
                        "name": "content-type",
                        "required": true
                    }
                ],
                "trafficRule": {
                    "type": "ALLOW"
                },
                "createdAt": "2025-10-13T15:57:30.874Z",
                "updatedAt": "2025-10-13T15:57:30.874Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/inboundTrafficPolicies/8150f7dc-2ebb-4d0f-9581-f5e8ddca49c0"
                    }
                },
                "id": "8150f7dc-2ebb-4d0f-9581-f5e8ddca49c0",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Signature Policy",
                "enabled": true,
                "priority": 300,
                "verifyRules": [
                    {
                        "type": "MTLS_THUMBPRINT",
                        "sha256Thumbprints": [
                            "d2a0f8b4b8e17450c2a0cf6f0a0ddba02b31f16e417fe4906d77a5f3e92323c4",
                            "5f9c4c8dfb82c0dd7641f87825899b39b89980ff3c2c8c2c13e5ec61b52e4498",
                            "a6cbfa78e9f6a13859cb5a4e489b0b7fa6427bba8e56a9f07e109db91f89c9dd",
                            "c9e8a55f6f64d0f33f8fc6a81f6c0f1a7d5c74b0c7b3acacbe45a2f0f605ea12",
                            "0d4b571c6f6b4a3c6c35eb72b6c65a2f7bafc74ef5a2c8e3e6f741ab2c9e8f37"
                        ]
                    },
                    {
                        "type": "SIGNATURE",
                        "jwks": "{ \"keys\": [ { \"kty\": \"RSA\", \"e\": \"AQAB\", \"use\": \"sig\", \"kid\": \"q3sWApYjHZQLmWMUdAIqZiVWSshDdau5eI4K_Bm65Us\", \"alg\": \"RS256\", \"n\": \"jWA_vDxg41NrYJdIiv3BcljMy7V15bMyOyK5aJov6FgUTE2Xm_B9SqJu55qmS3CxVhvYWSpRIZvhrgap19CE_VnrAc5pzwj2oSEmDRXXFSGmMjHAmfTXU66nDZVmhbtDIBkPU-h55RDZf6zIn3SPOrmWJYj0G5X2fMJfbUOpuROjH1aMqqGOxcT-dX-LA0dd94LrH4J-g1HFeGZqw-uyQO8l1g6fbQYVaNvnHtw9V7U7I684Ks-3sZcU-YhexNhiN53izIglhdVva9pjSTUk4BnmYtSlfyF6HzUYkvg3H1S0Y6LqzW8lOIw8SF-L6jQqkT2DPDwDbxzNoaNx8lIE0Q\" } ]}"
                    }
                ],
                "clientIpRule": {
                    "type": "SOCKET"
                },
                "headerRules": [
                    {
                        "name": "x-required",
                        "required": true
                    }
                ],
                "trafficRule": {
                    "type": "BLOCK"
                },
                "createdAt": "2025-10-13T15:55:58.750Z",
                "updatedAt": "2025-10-13T15:55:58.750Z"
            }
        ]
    },
    "size": 2
}