declarativeNetRequest.RuleAction

Details of the action to take if a rule is matched, as the action property of a declarativeNetRequest.Rule.

Type

Values of this type are objects. They contain these properties:

redirect Optional

declarativeNetRequest.Redirect. Describes how the redirect should be performed. Only valid for redirect rules.

requestHeaders Optional

declarativeNetRequest.ModifyHeaderInfo. The request headers to modify for the request. Only valid if type is "modifyHeaders".

responseHeaders Optional

declarativeNetRequest.ModifyHeaderInfo. The response headers to modify for the request. Only valid if type is "modifyHeaders".

type

A string. The type of action to perform. Possible values are "block", "redirect", "allow", "upgradeScheme", "modifyHeaders", and "allowAllRequests". The use of the "redirect" and "modifyHeaders" actions require host permissions for the request and request initiator. The "block" and "upgradeScheme" actions also require host permissions unless the "declarativeNetRequest" permission is specified. Without these permissions, matching rules are ignored. See Permissions at declarativeNetRequest for more information. More details about the effects of rule actions are provided in Matching precedence.

Example extensions

Browser compatibility

Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
RuleAction
requestHeaders
requestHeaders.header
requestHeaders.operation
requestHeaders.value
responseHeaders
responseHeaders.header
responseHeaders.operation
responseHeaders.value