API

failAction

  • Property Manager name: Site Failover
  • Behavior version: The v2025-10-16 rule format supports the failAction behavior v1.7.
  • Rule format status: GA, stable
  • Access: Read/Write
  • Allowed in includes: Yes

Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an origin​Timeout or match​Response​Code.

OptionTypeDescriptionRequires
enabledboolean

When enabled in case of a failure to contact the origin, the current behavior applies.

{"displayType":"boolean","tag":"input","type":"checkbox"}
action​Typeenum 
Specifies the basic action to take when there is a failure to contact the origin.
{"displayType":"enum","options":["SERVE_STALE","REDIRECT","RECREATED_CO","RECREATED_CEX","RECREATED_NS","DYNAMIC"],"tag":"select"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
SERVE_​STALE
Serves content that is already in the cache.
REDIRECT
Specifies a redirect action. (Use with these options: redirect​Hostname​Type, redirect​Hostname, redirect​Custom​Path, redirect​Path, redirect​Method, modify​Protocol, and protocol.)
RECREATED_​CO
Serves alternate content from your network.  (Use with these options: content​Hostname, content​Custom​Path, and content​Path.)
RECREATED_​CEX
Serves alternate content from an external network.  (Use with these options: cex​Hostname, cex​Custom​Path, and cex​Path.)
RECREATED_​NS
Serves Net​Storage content. (Use with these options: net​Storage​Hostname, net​Storage​Path, and cp​Code.)
DYNAMIC
Allows you to serve dynamic Saa​S content if Saa​S acceleration is available on your contract.  (Use with these options: dynamic​Method, dynamic​Custom​Path, saas​Type, saas​Suffix, saas​Regex, and saas​Replace.)
saas​Typeenum 
Identifies the component of the request that identifies the Saa​S dynamic fail action.
action​Type is DYNAMIC
{"displayType":"enum","options":["HOSTNAME","PATH","QUERY_STRING","COOKIE"],"tag":"select"}
{"if":{"attribute":"actionType","op":"eq","value":"DYNAMIC"}}
Supported values: 
COOKIE
HOSTNAME
PATH
QUERY_STRING
saas​Cname​Enabledboolean 
Specifies whether to use a CNAME chain to determine the hostname for the Saa​S dynamic failaction.
saas​Type is HOSTNAME
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"saasType","op":"eq","value":"HOSTNAME"}}
saas​Cname​Levelnumber 
Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the Saa​S dynamic failaction.
saas​Cname​Enabled is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"saasCnameEnabled","op":"eq","value":true}}
saas​Query​Stringstring (allows variables)
Specifies the name of the query parameter that identifies this Saa​S dynamic failaction.
saas​Type is QUERY_​STRING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"saasType","op":"eq","value":"QUERY_STRING"}}
saas​Regexstring 
Specifies the substitution pattern (a Perl-compatible regular expression) that defines the Saa​S dynamic failaction.
action​Type is DYNAMIC
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"actionType","op":"eq","value":"DYNAMIC"}}
saas​Replacestring (allows variables)
Specifies the replacement pattern that defines the Saa​S dynamic failaction.
action​Type is DYNAMIC
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"actionType","op":"eq","value":"DYNAMIC"}}
saas​Suffixstring (allows variables)
Specifies the static portion of the Saa​S dynamic failaction.
action​Type is DYNAMIC
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"actionType","op":"eq","value":"DYNAMIC"}}
dynamic​Methodenum 
Specifies the redirect method.
action​Type is DYNAMIC
{"displayType":"enum","options":["SERVE_301","SERVE_302","SERVE_ALTERNATE"],"tag":"select"}
{"if":{"attribute":"actionType","op":"eq","value":"DYNAMIC"}}
SERVE_301
A 301 redirect response.
SERVE_302
A 302 redirect response.
SERVE_​ALTERNATE
Serve an alternate response.
dynamic​Custom​Pathboolean 
Allows you to modify the original requested path.
action​Type is DYNAMIC
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"actionType","op":"eq","value":"DYNAMIC"}}
dynamic​Pathstring (allows variables)
Specifies the new path.
dynamic​Custom​Path is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"dynamicCustomPath","op":"eq","value":true}}
redirect​Hostname​Typeenum 
Whether to preserve or customize the hostname.
action​Type is REDIRECT
{"displayType":"enum","options":["ORIGINAL","ALTERNATE"],"tag":"select"}
{"if":{"attribute":"actionType","op":"eq","value":"REDIRECT"}}
ORIGINAL
Preserve the original hostname in the redirect.
ALTERNATE
Specify a redirect​Hostname.
redirect​Hostnamestring (allows variables)
When the action​Type is REDIRECT and the redirect​Hostname​Type is ALTERNATE, this specifies the hostname for the redirect.
redirect​Hostname​Type is ALTERNATE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"redirectHostnameType","op":"eq","value":"ALTERNATE"}}
redirect​Custom​Pathboolean 
Uses the redirect​Path to customize a new path.
action​Type is REDIRECT
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"actionType","op":"eq","value":"REDIRECT"}}
redirect​Pathstring (allows variables)
Specifies a new path.
redirect​Custom​Path is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"redirectCustomPath","op":"eq","value":true}}
redirect​Methodenum 
Specifies the HTTP response code.
action​Type is REDIRECT
{"displayType":"enum","options":["302","301"],"tag":"select"}
{"if":{"attribute":"actionType","op":"eq","value":"REDIRECT"}}
Supported values: 
301
302
content​Hostnamestring (allows variables)
Specifies the static hostname for the alternate redirect.
action​Type is RECREATED_​CO
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_CO"}}
content​Custom​Pathboolean 
Specifies a custom redirect path.
action​Type is RECREATED_​CO
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_CO"}}
content​Pathstring (allows variables)
Specifies a custom redirect path.
content​Custom​Path is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"contentCustomPath","op":"eq","value":true}}
net​Storage​Hostnameobject 
When the action​Type is RECREATED_​NS, specifies the Net​Storage origin to serve the alternate content. Contact Akamai Professional Services for your Net​Storage origin's id.
action​Type is RECREATED_​NS
{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_NS"}}
net​Storage​Hostname.cp​Codeinteger
Identifies a CP code assigned to this storage group.
net​Storage​Hostname.download​Domain​Namestring
Domain name from which content can be downloaded.
net​Storage​Hostname.g2o​Tokenstring
Signature Header Authentication key.
net​Storage​Hostname.idinteger
Unique identifier for the storage group.
net​Storage​Hostname.namestring
Name of the storage group.
net​Storage​Pathstring (allows variables)
When the action​Type is RECREATED_​NS, specifies the path for the Net​Storage request.
action​Type is RECREATED_​NS
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_NS"}}
cex​Hostnamestring (allows variables)
Specifies a hostname.
action​Type is RECREATED_​CEX
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_CEX"}}
cex​Custom​Pathboolean 
Specifies a custom path.
action​Type is RECREATED_​CEX
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_CEX"}}
cex​Pathstring (allows variables)
Specifies a custom path.
cex​Custom​Path is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"cexCustomPath","op":"eq","value":true}}
cp​Codeobject 
Specifies a CP code for which to log errors for the Net​Storage location. You only need to provide the initial id, stripping any cpc_ prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
action​Type is RECREATED_​NS
{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_NS"}}
cp​Code.cp​Code​Limitsarray
Read-only. Describes the current usage limit for the CP code.
cp​Code.created​Dateinteger
Read-only. UNIX epoch timestamp reflecting when the CP code was originally created.
cp​Code.descriptionstring
Read-only. Additional description for the CP code.
cp​Code.idinteger
Unique identifier for each CP code. Initially, you get this value when creating a new CP code in PAPI. You can also assign a cpcode​Id value from the List CP codes operation.
cp​Code.namestring
Read-only. The name of the CP code you specify as the cpcode​Name when creating a new CP code in PAPI. You can modify this value with the PUT operation in the CP codes and Reporting Groups API.
cp​Code.productsarray
Read-only. The set of products the CP code is assigned to. This reflects product​Id values you specify when creating a new CP code in PAPI.
status​Codeenum 
Assigns a new HTTP status code to the failure response.
action​Type is RECREATED_​NS
{"displayType":"enum","options":["200","404","500","100","101","102","103","122","201","202","203","204","205","206","207","226","400","401","402","403","405","406","407","408","409","410","411","412","413","414","415","416","417","422","423","424","425","426","428","429","431","444","449","450","499","501","502","503","504","505","506","507","509","510","511","598","599"],"tag":"select"}
{"if":{"attribute":"actionType","op":"eq","value":"RECREATED_NS"}}
Supported values: 
100
101
102
103
122
200
201
202
203
204
205
206
207
226
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
422
423
424
425
426
428
429
431
444
449
450
499
500
501
502
503
504
505
506
507
509
510
511
598
599
preserve​Query​Stringboolean 
When using either content​Custom​Path, cex​Custom​Path, dynamic​Custom​Path, or redirect​Custom​Path to specify a custom path, enabling this passes in the original request's query string as part of the path.
content​Custom​Path is true
OR cex​Custom​Path is true
OR redirect​Custom​Path is true
OR dynamic​Custom​Path is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"or","params":[{"attribute":"contentCustomPath","op":"eq","value":true},{"attribute":"cexCustomPath","op":"eq","value":true},{"attribute":"redirectCustomPath","op":"eq","value":true},{"attribute":"dynamicCustomPath","op":"eq","value":true}]}}
modify​Protocolboolean 
Modifies the redirect's protocol using the value of the protocol field.
action​Type is REDIRECT
OR dynamic​Method is either: SERVE_301, SERVE_302
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"or","params":[{"attribute":"actionType","op":"eq","value":"REDIRECT"},{"attribute":"dynamicMethod","op":"in","value":["SERVE_301","SERVE_302"]}]}}
protocolenum 
When the action​Type is REDIRECT and modify​Protocol is enabled, this specifies the redirect's protocol.
modify​Protocol is true
{"displayType":"enum","options":["HTTP","HTTPS"],"tag":"select"}
{"if":{"attribute":"modifyProtocol","op":"eq","value":true}}
Supported values: 
HTTP
HTTPS