Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/source/admin/traffic_router.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,20 @@ Much of a Traffic Router's configuration can be obtained through the :term:`Para
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| geolocation.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for an updated geographic IP mapping database. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| certificates.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for Delivery Service certificates. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| certificate.api.url | CRConfig.json | The location (URL) where Traffic Router can request Delivery Service certificates from. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| regional_geoblock.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for Regional Geo-blocking rules. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| regional_geoblock.polling.url | CRConfig.json | The location (URL) where Traffic Router can request Regional Geo-blocking rules from. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| anonymousip.policy.configuration | CRConfig.json | The location (URL) where Traffic Router can request the Anonymous IP Blocking configuration file from. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| anonymousip.polling.url | CRConfig.json | The location (URL) where Traffic Router can request the Anonymous IP Database from. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| anonymousip.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for the Anonymous IP Blocking configuration and database |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| coveragezone.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for an updated :term:`Coverage Zone Map`. |
+-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| coveragezone.polling.url | CRConfig.json | The location (URL) where a :term:`Coverage Zone Map` may be found. |
Expand Down
10 changes: 5 additions & 5 deletions docs/source/api/v3/cdns_name_snapshot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ Response Structure
:config: An object containing basic configurations on the actual CDN object

:api.cache-control.max-age: A string containing an integer which specifies the value of ``max-age`` in the :mailheader:`Cache-Control` header of some HTTP responses, likely the :ref:`tr-api` responses
:certificates.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for updated SSL certificates
:certificates.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for updated SSL certificates
:consistent.dns.routing: A string containing a boolean which indicates whether DNS routing will use a consistent hashing method or "round-robin"

"false"
The "round-robin" method will be used to define DNS routing
"true"
A consistent hashing method will be used to define DNS routing

:coveragezone.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should check for a new Coverage Zone file
:coveragezone.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which Traffic Routers should check for a new Coverage Zone file
:coveragezone.polling.url: The URL where a :term:`Coverage Zone File` may be requested by Traffic Routers
:dnssec.dynamic.response.expiration: A string containing a number and unit suffix that specifies the length of time for which dynamic responses to DNSSEC lookup queries should remain valid
:dnssec.dynamic.concurrencylevel: An integer that defines the size of the concurrency level (threads) of the Guava cache used by ZoneManager to store zone material
Expand All @@ -75,9 +75,9 @@ Response Structure
DNSSEC is used within this CDN

:domain_name: A string that is the :abbr:`TLD (Top-Level Domain)` served by the CDN
:federationmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new federation mappings
:federationmapping.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for new federation mappings
:federationmapping.polling.url: The URL where Traffic Control components can request federation mappings
:geolocation.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
:geolocation.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
:geolocation.polling.url: The URL where Traffic Control components can request IP-to-geographic-location mapping database files
:keystore.maintenance.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should refresh their zone caches
:neustar.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new "Neustar" databases
Expand All @@ -97,7 +97,7 @@ Response Structure

.. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.

:steeringmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Control components should check for new steering mappings
:steeringmapping.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which Traffic Control components should check for new steering mappings
:ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
:zonemanager.cache.maintenance.interval: A configuration option for the ZoneManager Java class of Traffic Router
:zonemanager.threadpool.scale: A configuration option for the ZoneManager Java class of Traffic Router
Expand Down
10 changes: 5 additions & 5 deletions docs/source/api/v3/cdns_name_snapshot_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,15 @@ Response Structure
:config: An object containing basic configurations on the actual CDN object

:api.cache-control.max-age: A string containing an integer which specifies the value of ``max-age`` in the :mailheader:`Cache-Control` header of some HTTP responses, likely the :ref:`tr-api` responses
:certificates.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for updated SSL certificates
:certificates.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for updated SSL certificates
:consistent.dns.routing: A string containing a boolean which indicates whether DNS routing will use a consistent hashing method or "round-robin"

"false"
The "round-robin" method will be used to define DNS routing
"true"
A consistent hashing method will be used to define DNS routing

:coveragezone.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should check for a new Coverage Zone file
:coveragezone.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which Traffic Routers should check for a new Coverage Zone file
:coveragezone.polling.url: The URL where a :term:`Coverage Zone File` may be requested by Traffic Routers
:dnssec.dynamic.response.expiration: A string containing a number and unit suffix that specifies the length of time for which dynamic responses to DNSSEC lookup queries should remain valid
:dnssec.dynamic.concurrencylevel: An integer that defines the size of the concurrency level (threads) of the Guava cache used by ZoneManager to store zone material
Expand All @@ -74,9 +74,9 @@ Response Structure
DNSSEC is used within this CDN

:domain_name: A string that is the :abbr:`TLD (Top-Level Domain)` served by the CDN
:federationmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new federation mappings
:federationmapping.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for new federation mappings
:federationmapping.polling.url: The URL where Traffic Control components can request federation mappings
:geolocation.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
:geolocation.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
:geolocation.polling.url: The URL where Traffic Control components can request IP-to-geographic-location mapping database files
:keystore.maintenance.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should refresh their zone caches
:neustar.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new "Neustar" databases
Expand All @@ -96,7 +96,7 @@ Response Structure

.. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.

:steeringmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Control components should check for new steering mappings
:steeringmapping.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which Traffic Control components should check for new steering mappings
:ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
:zonemanager.cache.maintenance.interval: A configuration option for the ZoneManager Java class of Traffic Router
:zonemanager.threadpool.scale: A configuration option for the ZoneManager Java class of Traffic Router
Expand Down
10 changes: 5 additions & 5 deletions docs/source/api/v4/cdns_name_snapshot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,15 @@ Response Structure
:config: An object containing basic configurations on the actual CDN object

:api.cache-control.max-age: A string containing an integer which specifies the value of ``max-age`` in the :mailheader:`Cache-Control` header of some HTTP responses, likely the :ref:`tr-api` responses
:certificates.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for updated SSL certificates
:certificates.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for updated SSL certificates
:consistent.dns.routing: A string containing a boolean which indicates whether DNS routing will use a consistent hashing method or "round-robin"

"false"
The "round-robin" method will be used to define DNS routing
"true"
A consistent hashing method will be used to define DNS routing

:coveragezone.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should check for a new Coverage Zone file
:coveragezone.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which Traffic Routers should check for a new Coverage Zone file
:coveragezone.polling.url: The URL where a :term:`Coverage Zone File` may be requested by Traffic Routers
:dnssec.dynamic.response.expiration: A string containing a number and unit suffix that specifies the length of time for which dynamic responses to DNSSEC lookup queries should remain valid
:dnssec.dynamic.concurrencylevel: An integer that defines the size of the concurrency level (threads) of the Guava cache used by ZoneManager to store zone material
Expand All @@ -76,9 +76,9 @@ Response Structure
DNSSEC is used within this CDN

:domain_name: A string that is the :abbr:`TLD (Top-Level Domain)` served by the CDN
:federationmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new federation mappings
:federationmapping.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for new federation mappings
:federationmapping.polling.url: The URL where Traffic Control components can request federation mappings
:geolocation.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
:geolocation.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which other Traffic Control components should check for new IP-to-geographic-location mapping databases
:geolocation.polling.url: The URL where Traffic Control components can request IP-to-geographic-location mapping database files
:keystore.maintenance.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Routers should refresh their zone caches
:neustar.polling.interval: A string containing an integer which specifies the interval, in seconds, on which other Traffic Control components should check for new "Neustar" databases
Expand All @@ -98,7 +98,7 @@ Response Structure

.. seealso:: `The Wikipedia page on Start of Authority records <https://en.wikipedia.org/wiki/SOA_record>`_.

:steeringmapping.polling.interval: A string containing an integer which specifies the interval, in seconds, on which Traffic Control components should check for new steering mappings
:steeringmapping.polling.interval: A string containing an integer which specifies the interval, in milliseconds, on which Traffic Control components should check for new steering mappings
:ttls: An object that contains keys which are types of DNS records that have values which are strings containing integers that specify the time for which a response to the specific type of record request should remain valid
:zonemanager.cache.maintenance.interval: A configuration option for the ZoneManager Java class of Traffic Router
:zonemanager.threadpool.scale: A configuration option for the ZoneManager Java class of Traffic Router
Expand Down
Loading