Sign in
Traffic Policy Profiles

Get all traffic policy profiles

Get all traffic policy profiles belonging to the user that match the given filters.

get/traffic_policy_profiles

Query parameters

page[number]integer

The page number to load.

page[size]integer

The size of the page.

filter[type]'whitelist' | 'blacklist' | 'throttling'

Filter by traffic policy profile type.

filter[service]string

Filter by service ID.

sort'service' | '-service' | 'type' | '-type'

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

Response

Successful Response

Example response

{
  "data": [
    {
      "created_at": "2018-02-02T22:25:27.521Z",
      "domains": [
        "www.hbomax.com",
        "netflix.com"
      ],
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "ip_ranges": [
        "10.64.0.0/24",
        "10.64.0.0/25"
      ],
      "limit_bw_kbps": 512,
      "record_type": "traffic_policy_profile",
      "services": [
        "service_123",
        "service_456"
      ],
      "type": "whitelist",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Changes

Changed in 2 of the 61 revisions of this API.2

  • 1571b0380bd71See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379941See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog