API
TrainingSupportCommunity

sureRoute

The Sure​Route feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conducts races to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly.

This behavior allows you to configure Sure​Route along with a test object to improve delivery of non-cacheable no-store or bypass-cache content. Since edge servers are already positioned as close as possible to requesting clients, the behavior does not apply to cacheable content.

OptionTypeDescriptionRequires
enabledboolean

Enables the Sure​Route behavior, to optimize delivery of non-cached content.

{"displayType":"boolean","tag":"input","type":"checkbox"}
typeenum 
Specifies the set of edge servers used to test routes.
{"displayType":"enum","options":["PERFORMANCE","CUSTOM_MAP"],"tag":"select"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
PERFORMANCE
Use the default set of edge servers.
CUSTOM_​MAP
A custom map that you need to get from Akamai Professional Services.
custom​Mapstring 
If type is CUSTOM_​MAP, this specifies the map string provided to you by Akamai Professional Services, or included as part of the Site Shield product.
type is CUSTOM_​MAP
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"type","op":"eq","value":"CUSTOM_MAP"}}
test​Object​Urlstring 
Specifies the path and filename for your origin's test object to use in races to test routes.
Akamai provides sample test objects for the Dynamic Site Accelerator and Web Application Accelerator products. If you want to use your own test object, it needs to be on the same origin server as the traffic being served through Sure​Route. Make sure it returns a 200 HTTP response and does not require authentication.  The file should be an average-sized static HTML file (Content-Type: text/html) that is no smaller than 8KB, with no back-end processing.
If you have more than one origin server deployed behind a load balancer, you can configure it to serve the test object directly on behalf of the origin, or route requests to the same origin server to avoid deploying the test object on each origin server.
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
to​Host​Statusenum 
Specifies which hostname to use.
{"displayType":"enum","options":["INCOMING_HH","OTHER"],"tag":"select"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
INCOMING_​HH
Use the incoming Host header when requesting the Sure​Route test object.
OTHER
Use to​Host to specify a custom Host header.
to​Hoststring 
If to​Host​Status is OTHER, this specifies the custom Host header to use when requesting the Sure​Route test object.
to​Host​Status is OTHER
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"toHostStatus","op":"eq","value":"OTHER"}}
race​Stat​Ttlstring (duration)
Specifies the time-to-live to preserve Sure​Route race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
force​Ssl​Forwardboolean 
Forces Sure​Route to use SSL when requesting the origin's test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
enable​Custom​Keyboolean 
When disabled, caches race results under the race destination's hostname. If enabled, use custom​Stat​Key to specify a custom hostname.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
custom​Stat​Keystring 
This specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, Sure​Route would launch races for each origin, but consolidating under a single hostname runs only one race.
enable​Custom​Key is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enableCustomKey","op":"eq","value":true}}