Schema — Rules

Property	Usage	Required	Type	Description
`id`	Auto generated Read-Only	No	String	Unique ID for your rule. This starts with the rule type followed by a 5 character long unique string. For example id of a redirect rule could be `Redirect_fohh4`
`name`	User defined Required Can be updated	Yes	String	Name of the Rule
`description`	User defined Optional Can be updated	No	String	Description of the Rule
`status`	Can be updated `Inactive` by default	No	String	Can be either `Inactive` or `Active`
`groupId`	An empty groupId denotes an ungrouped rule. So this is required if you want to keep the rule grouped	No	String	Defines the group the rule is a part of. Groups are separate objects that are not currently editable by the API. But you can update this property to another existing group.
`ruleType`	Required Can not be changed after creation.	Yes	String	Takes one of the following values: `Redirect` `Cancel` `Replace` `Headers` `UserAgent` `Script` `QueryParam` `Response` `Request` `Delay`
`pairs`	Required Should always match the schema based on the rule type	Yes	Array of Pairs	Array of pairs that are part of the rule. Read more about pairs below

There are other attributes that are all read only and are automatically handled by the backend. These are not important to understand when you are just working with the API but you will still see them in the response from the API

Property	Type	Description
`createdBy`	String	id of user who created the rule
`creationDate`	Number	Timestamp of when the rule was created
`lastModifiedBy`	String	The id of the user who last modified the rule. This might be different from the value in `createdBy` in case the rule is part of a workspace
`modificationDate`	Number	Timestamp of last modification
`currentOwner`	String	Deprecated: Who owns the rule currently
`objectType`	String	Value: `rule`

Rule pairs

Every rule has an array of rule pairs that contain:

The matching condition inside the source property

The rest of the details for the rules

The details and their schema vary based on the type of the rule,

But the schema of the source property is consistent throughout all the rules.

Source Schema

This is common for all Rule types. You can get a better understanding about what each operator does by going through the user docs

Property	Usage	Type	Description
`key`	Required	String	The key for the source. Can be one of the following values: `Url`, `host`, `path`
`operator`	Required	String	The operator for matching. Can be one of the following values: `Equals`, `Contains`, `Matches`, `Wildcard_Matches`
`value`	Required	String	The value to match against
`filters`	Optional	Array of Filter objects	Filters are used for more accurate targeting of the requests

Filters

To learn more about the filters, read the user documentation on advanced rule targetting. Filters have the following schema:

Property	Usage	Type	Description
`requestMethod`	Optional	Array of String	An array of HTTP method strings like `GET`, `POST`, etc.
`resourceType`	Optional	Array of String	The type of resource being requested. Possible values listed below.
`URL`	Optional	Object	Host Page URL. This is similar to the source object, except it only requires the `operator` and `value` properties, both are required

The possible values for resourceType in the filters object are

xmlhttprequest - To target only XHR requests

script - Requests for javascript files

stylesheet - Request for css files

image - Request for images. These include files like png, jpeg, etc.

media - Request for any media files, like video, audio, gifs, etc.

font - Request for any font files like .ttf, .otf, etc

websocket - All websocket requests. Not the Web socket upgrade request, but the requests made with the ws or wss protocol

main_frame - Request made from the top level document

sub_frame - Requests made from an iframe inside the top level document

Redirect Rule Pair

Refer the user docs for a better understanding about Redirect Rule. In case of this rule ruleType property of the rule is set to Redirect

The schema of the pairs is as follows:

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching
`destinationType`	Required	String	The type of destination. Can be one of the following values: `url`, `map_local`, `mock_or_file_picker`
`destination`	Required	String	The destination url value

Cancel Rule

Refer the user docs for a better understanding about Cancel Rule. In case of this rule ruleType property of the rule is set to Cancel

The schema of its pairs only requires the source object

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching

Replace Rule

Refer the user docs for a better understanding about Replace Rule. In case of this rule ruleType property of the rule is set to Replace

The schema of the pairs is as follows:

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching
`from`	Required	String	Target string that will be replaced
`to`	Required	String	The final replaced value

Headers Rule

Refer the user docs for a better understanding about Header Rule. In case of this rule ruleType property of the rule is set to Header

The schema of the pairs is as follows:

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching
`modifications`	Required	Array of Request/Response Modifications	Defines modifications for both `Request` and `Response`

Header rule modification object

Each modification is an object that has the following structure

Property	Usage	Type	Description
`Request`	Optional	Array of modifications	Modifications to be applied on the request headers
`Response`	Optional	Array of modifications	Modifications to be applied on the response headers

The modifications Object for both request and response are as follows

Property	Usage	Type	Description
`header`	Required	String	The name of the header to modify
`type`	Required	String	The type of modification. Can be one of the following values: `Add`, `Remove`, `Modify`
`value`	Required (for `Add` and `Modify` types)	String	The value to set for the header

User-Agent Rule

Refer the user docs for a better understanding about User-Agent Rule. In case of this rule ruleType property of the rule is set to UserAgent

The schema of the pairs is as follows:

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching
`userAgent`	Required	String	The user agent value to set

Query Param Rule

Refer the user docs for a better understanding about Query Param Rule. In case of this rule ruleType property of the rule is set to QueryParam

The schema of the pairs is as follows:

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching
`modifications`	Required	Array of modification objects	The array of query parameter modifications.

Modification object for query param rule

The modification objects for this rule are as follows

Property	Usage	Type	Description
`param`	Required	String	The name of the query parameter to modify
`type`	Required	String	The type of modification. Can be one of the following values: `Add`, `Remove`, `Remove All`
`value`	Required (for `Add` and `Modify` types)	String	The value to set for the query parameter

Modify Response Rule

In case of this rule ruleType property of the rule is set to Response

The schema of the pairs is as follows:

Property	Usage	Type	Description
`type`	Required	String	The type of response. Can be one of the following values: `code`, `static`
`value`	Required	String	The value of the response, either a status code or a static response.
`serveWithoutRequest`	Optional	Boolean	When enabled, response is served directly from Requestly and does not reach the backend. `false` by default

Remember that in case of the code type, you have special arguments that are passed to the custom function that you define. Go through the user docs for a list of arguments that you might find useful

Modify Request Rule Schema

In case of this rule ruleType property of the rule is set to Request

The schema of the pairs is as follows:

Property	Usage	Type	Description
`type`	Required	String	The type of request. Can be one of the following values: `code`, `static`
`value`	Required	String	The value of the request, either a request code or a static request

Delay Rule

Refer the user docs for a better understanding about Delay Rule. In case of this rule ruleType property of the rule is set to Delay

Property	Usage	Type	Description
`source`	Required	Object	The source object for matching
`delay`	Required	number	Delay value in milliseconds

Rule schema Rule pairs Source Schema Filters Redirect Rule Pair Cancel Rule Replace Rule Headers Rule Header rule modification object User-Agent Rule Query Param Rule Modification object for query param rule Modify Response Rule Modify Request Rule Schema Delay Rule