API
TrainingSupportCommunity

originFailureRecoveryPolicy

Configures how to detect an origin failure, in which case the origin​Failure​Recovery​Method behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process in Adaptive Media Delivery Implementation Guide. You can use the origin​Failure​Recovery​Method member to edit existing instances of the Origin Failure Recover Method behavior.

OptionTypeDescriptionRequires
enabledboolean

Activates and configures a recovery policy.

{"displayType":"boolean","tag":"input","type":"checkbox"}
enable​IPAvoidanceboolean 
Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the config​Name established for origin​Responsiveness​Recovery​Config​Name is applied.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
ip​Avoidance​Error​Thresholdnumber 
Defines the number of failures that need to occur to an origin address before it's blocked.
enable​IPAvoidance is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"enableIPAvoidance","op":"eq","value":true}}
ip​Avoidance​Retry​Intervalnumber 
Defines the number of seconds after which the IP address is removed from the blocklist.
enable​IPAvoidance is true
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"enableIPAvoidance","op":"eq","value":true}}
binary​Equivalent​Contentboolean 
Synchronizes content between the primary and backup origins, byte for byte.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor​Origin​Responsivenessboolean 
Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
origin​Responsiveness​Timeoutenum 
The timeout threshold that triggers a retry or recovery action.
monitor​Origin​Responsiveness is true
{"displayType":"enum","options":["AGGRESSIVE","MODERATE","CONSERVATIVE","USER_SPECIFIED"],"tag":"select"}
{"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
AGGRESSIVE
A 2 second threshold.
MODERATE
3 seconds.
CONSERVATIVE
4 seconds.
USER_​SPECIFIED
Specify your own timeout.
origin​Responsiveness​Custom​Timeoutnumber 
Specify a custom timeout, from 1 to 10 seconds.
origin​Responsiveness​Timeout is USER_​SPECIFIED
{"displayType":"number","tag":"input","type":"number"}
{"if":{"attribute":"originResponsivenessTimeout","op":"eq","value":"USER_SPECIFIED"}}
origin​Responsiveness​Enable​Retryboolean 
If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
monitor​Origin​Responsiveness is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
origin​Responsiveness​Enable​Recoveryboolean 
Enables a recovery action for a specific failure condition.
monitor​Origin​Responsiveness is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorOriginResponsiveness","op":"eq","value":true}}
origin​Responsiveness​Recovery​Config​Namestring 
Specifies a recovery configuration using the config​Name you defined in the recovery​Config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery​Config match criteria to apply this option.
origin​Responsiveness​Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"originResponsivenessEnableRecovery","op":"eq","value":true}}
monitor​Status​Codes1boolean 
Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor​Response​Codes1string array 
Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (501) or a range (501:504). If you configure other monitor​Status​Codes* and monitor​Response​Codes* options, you can't use the same codes here.
monitor​Status​Codes1 is true
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
monitor​Status​Codes1Enable​Retryboolean 
When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
monitor​Status​Codes1 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
monitor​Status​Codes1Enable​Recoveryboolean 
Enables the recovery action for the response codes you define.
monitor​Status​Codes1 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes1","op":"eq","value":true}}
monitor​Status​Codes1Recovery​Config​Namestring 
Specifies a recovery configuration using the config​Name you defined in the recovery​Config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery​Config match criteria to apply this option.
monitor​Status​Codes1Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"monitorStatusCodes1EnableRecovery","op":"eq","value":true}}
monitor​Status​Codes2boolean 
Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor​Response​Codes2string array 
Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (501) or a range (501:504). If you configure other monitor​Status​Codes* and monitor​Response​Codes* options, you can't use the same codes here.
monitor​Status​Codes2 is true
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
monitor​Status​Codes2Enable​Retryboolean 
When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
monitor​Status​Codes2 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
monitor​Status​Codes2Enable​Recoveryboolean 
Enables the recovery action for the response codes you define.
monitor​Status​Codes2 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes2","op":"eq","value":true}}
monitor​Status​Codes2Recovery​Config​Namestring 
Specifies a recovery configuration using the config​Name you defined in the recovery​Config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery​Config match criteria to apply this option.
monitor​Status​Codes2Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"monitorStatusCodes2EnableRecovery","op":"eq","value":true}}
monitor​Status​Codes3boolean 
Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
monitor​Response​Codes3string array 
Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (501) or a range (501:504). If you configure other monitor​Status​Codes* and monitor​Response​Codes* options, you can't use the same codes here..
monitor​Status​Codes3 is true
{"displayType":"string array","tag":"input","todo":true}
{"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
monitor​Status​Codes3Enable​Retryboolean 
When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
monitor​Status​Codes3 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
monitor​Status​Codes3Enable​Recoveryboolean 
Enables the recovery action for the response codes you define.
monitor​Status​Codes3 is true
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"monitorStatusCodes3","op":"eq","value":true}}
monitor​Status​Codes3Recovery​Config​Namestring 
Specifies a recovery configuration using the config​Name you defined in the recovery​Config match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use the recovery​Config match criteria to apply this option.
monitor​Status​Codes3Enable​Recovery is true
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"monitorStatusCodes3EnableRecovery","op":"eq","value":true}}