API prioritization

This cloudlet's policy requires you send the matchRules array with the type parameter and passThroughPercent.

Use the optional parameters to build a more robust rule set.

Parameter Required Description
type ‚úĒ Your cloudlet type. The value for the API prioritization cloudlet is apMatchRule.
passThroughPercent ‚úĒ The percent of requests that pass through to the origin. Value options are:
  • 0.0-99.0.
  • 100 sets all requests to pass through.
  • -1 sends all requests to the waiting room.
name A human-readable name for your rule.
start The start time for the match. Value is UTC through seconds.
end The end time for the match. Value is UTC through seconds.
matchURL The URL that the cloudlet uses to match with the incoming request.
disabled Whether to disable a rule so it is not evaluated against incoming requests.
matches The match object definitions list. Use the options table to build out your match criteria.

Match definition options

The options listed are nested within the matches array.

All match options are optional.

Parameter Description
match_type The type of match used. Value is one of:
  • header
  • hostname
  • path
  • extension
  • query
  • cookie
  • deviceCharacteristics
  • clientip
  • continent
  • countrycode
  • regioncode
  • protocol
  • method
  • proxy
matchValue A value that reflects your match type, for example, if you set your match type to countrycode, the value would reflect the match country.
matchOperator Compares a string expression with a pattern. Value is one of:
  • contains
  • exists
  • equals
caseSensitive Whether the match is case sensitive.
negate Whether to negate the match.
checkIPs For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request to use as the IP address. Value options:
  • CONNECTING_IP
  • XFF_HEADERS
  • You can use both separated by a space. When both values are included, the connecting IP address is evaluated first.
objectMatchValue Use when a rule includes more complex match criteria, like multiple value attributes. Value options:
  • name. One of cookie, header, parameter, or query.
  • type. Required. The type of list, either object or simple.
  • nameCaseSensitive. Whether the evaluation of the name match is case sensitive.
  • nameHasWildcard. Whether the name match includes wildcards.
  • options. If you set the match type to object, use this to list the values on which to match.
    • value. The values in the incoming request on which to match.
    • valueHasWildcard. Whether the match value includes wildcards.
    • valueCaseSensitive. Whether the evaluation of the match value is case sensitive.
    • valueEscaped. Whether the compared match value can be an escaped form.
  • value. If you set the match type to simple, provide the values in the incoming request on which to match.