|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
object |
The object. |
||
| description |
string |
The route description. |
Agent route |
| match |
object |
The route matching rule. |
|
| methods |
array |
The list of HTTP methods. |
|
|
string |
The list of HTTP methods. |
||
| path |
object |
The path matching rule. |
|
| value |
string |
The path value to match. The specified |
|
| type |
string |
The type of path match. Valid values are |
|
| caseSensitive |
boolean |
Specifies whether the path match is case-sensitive. Defaults to |
|
| headers |
array |
The list of header matching rules. |
|
|
object |
The list of header matching rules. |
||
| name |
string |
The name of the HTTP header to match, such as |
|
| type |
string |
The type of header match. Valid values are |
|
| value |
string |
The value to match against the header. The match |
|
| caseSensitive |
boolean |
Specifies whether the header match is case-sensitive. Defaults to |
|
| queryParams |
array |
The list of query parameter matching rules. |
|
|
object |
The list of query parameter matching rules. |
||
| name |
string |
The name of the query parameter to match. |
|
| type |
string |
The type of query parameter match. Valid values are |
|
| value |
string |
The value to match against the query parameter. The match |
|
| caseSensitive |
boolean |
Specifies whether the query parameter match is case-sensitive. Defaults to |
|
| modelMatches |
array |
The list of model matching rules (specific to Agent API). |
|
|
object |
The list of model matching rules (specific to Agent API). |
||
| name |
string |
The name of the model field to match. |
|
| type |
string |
The type of match, such as |
|
| value |
string |
The value or pattern to match against the model field. |
|
| caseSensitive |
boolean |
Specifies whether the model field match is case-sensitive. Defaults to |
|
| builtin |
boolean |
Indicates whether the route is a built-in route. |
|
| domains |
array |
The list of associated domain names. |
|
| HiMarketDomain |
The list of associated domain names. |