ad_scaler_circuit_breaker

Suggest Edits

Version: `v2025-02-18`	Includes use: No

Behavior name: Ad Scaler Circuit Breaker

This behavior works with manifest_rerouting to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. The adScalerCircuitBreaker behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "ad_scaler_circuit_breaker" {
  rules_v2025_02_18 {
    name     = "Ad Scaler Circuit Breaker"
    comments = "Control the settings related to the fallback action when a partner gets errors and can't modify the requested media object."
    behavior {
      ad_scaler_circuit_breaker {
        response_delay_based   = false
        response_code_based    = false
      }
    }
  }
}

"behaviors": [
  {
    "name": "adScalerCircuitBreaker",
    "options": {
      "responseDelayBased": false,
      "responseCodeBased": false
    }
  }
]

Options

Option	Description
`response_delay_based`	Boolean Triggers a fallback action based on the delayed response from the technology partner's server.
`response_delay_threshold`	Enum \| Requires: `response_delay_based` is `true` Specifies the maximum response delay that, if exceeded, triggers the fallback action. Value: `500ms`
`response_code_based`	Boolean Triggers a fallback action based on the response code from the technology partner's server.
`response_codes`	String \| Requires: `response_code_based` is `true` Specifies the codes in the partner's response that trigger the fallback action. Value is one of: `SAME_AS_RECEIVED`. Return the same error received from the partner platform. `408`. Return a 408 error. `500`. Return a 500 error. `502`. Return a 502 error. `504`. Return a 504 error. `SPECIFY_YOUR_OWN`. Customize the error.
`fallback_action_response_code_based`	Enum \| Requires: `response_delay_based` or `response_code_based` is `true` Specifies the fallback action. Value is one of: `RETURN_AKAMAI_COPY`. Return an unmodified Akamai copy of the manifest file to the requesting client. `RETURN_ERROR`. Return an error as the server response.
`return_error_response_code_based`	Enum Requires: `fallback_action_response_code_based` is `RETURN_ERROR` Specifies the error to include in the response to the client. Value is one of: `SAME_AS_RECEIVED`. Return the same error received from the partner platform. `408`. Return a 408 error. `500`. Return a 500 error. `502`. Return a 502 error. `504`. Return a 504 error. `SPECIFY_YOUR_OWN`. Customize the error.
`specify_your_own_response_code_based`	String Defines a custom error response.

Updated 10 days ago