rq.request (Request object)

The rq.request object provides access to all details of the API request in your Requestly scripts. Read these properties in both pre-request and post-response scripts. In a pre-request script you can also modify the request that is sent: headers, query parameters, the URL, the method, and the body are all writable (in a post-response script the request has already been sent, so writes have no effect on the wire).

Properties and Methods

`rq.request.method`

The HTTP method of the request (e.g. GET, POST, PUT, OPTIONS, DELETE, PATCH, HEAD). Writable from a pre-request script: the value is uppercased on write (rq.request.method = 'post' sends POST), and it must be one of the methods above. Anything else is dropped with a console warning instead of being sent. Example:

console.log("Request Method: ", rq.request.method);

`rq.request.headers`

An object that holds the request headers. Read them with rq.request.headers.get(name), rq.request.headers.has(name), or rq.request.headers.all(), which returns a plain { name: value } object. JSON.stringify(rq.request.headers) returns {} because the object exposes only methods (which JSON.stringify omits), so use .all() when you want to serialize the headers. Example:

console.log("Headers: ", JSON.stringify(rq.request.headers.all()));

You can also modify request headers from a pre-request script. The methods below change the headers that are sent with the request. Use them in pre-request scripts; in post-response scripts the request has already been sent, so header changes have no effect. Header changes apply to HTTP and GraphQL requests.

`rq.request.headers.add(header)`

Adds a header. If a header with the same name already exists, this adds a second one (it does not replace the existing header). Parameters:

header (object or string): { key, value }, or a raw "Key: value" string (parsed at the first :, both sides trimmed). These are the same inputs Postman’s Header accepts. A header added with disabled: true is readable on the request but is not sent.

Example:

rq.request.headers.add({ key: "X-Trace-Id", value: "abc-123" });
rq.request.headers.add("X-Trace-Id: abc-123"); // same effect

`rq.request.headers.upsert(header)`

Adds a header, or replaces it if a header with the same name already exists. Header names are matched case-insensitively. Parameters:

header (object): { key, value } - the header name and value.

Example:

rq.request.headers.upsert({ key: "Authorization", value: "Bearer " + rq.environment.get("authToken") });

`rq.request.headers.remove(name)`

Removes every header with the given name (case-insensitive). Parameters:

name (string): The header name to remove.

Example:

rq.request.headers.remove("X-Debug");

`rq.request.headers.clear()`

Removes all request headers. Parameters: none. Any argument passed is ignored. clear() always removes every header, so to remove a single header use remove(name) instead. Example:

rq.request.headers.clear();

The same operations are available directly on rq.request, with Postman’s exact signatures, including Postman’s case-sensitivity split, which differs from the headers.* methods above:

rq.request.addHeader(header) - same inputs as headers.add (object or "Key: value" string).
rq.request.removeHeader(toRemove, options?) - a header name string or a { key } object. Matches case-sensitively by default; pass { ignoreCase: true } for a case-insensitive match. (headers.remove(name) is always case-insensitive.)
rq.request.upsertHeader(header) - requires a truthy key (returns silently otherwise) and matches case-sensitively: a differently-cased key adds a second header instead of replacing. (headers.upsert matches case-insensitively.)

`rq.request.body`

The request body, as Postman’s RequestBody object: { mode, raw, urlencoded, formdata, graphql, options, disabled }. It is undefined when the request has no body. It still reads as a string wherever JavaScript coerces: `${rq.request.body}`, String(rq.request.body), and JSON.parse(rq.request.body) all see the raw text. But it is an object, so string methods need rq.request.body.toString() first (the same one-line edit rq.request.url needed). Writable from a pre-request script. Whatever your script writes is sent exactly as written, byte for byte, with no variable resolution applied to it. That is what makes signing flows correct:

// Replace the whole body with a raw string:
rq.request.body.update('{"signed": true}');

// Or plain assignment, same effect:
rq.request.body = '{"signed": true}';

// Select the content type via Postman's options.raw.language
// (an explicit Content-Type header row always wins over it):
rq.request.body.update({ mode: 'raw', raw: '{"a":1}', options: { raw: { language: 'json' } } });

// Other modes: urlencoded, formdata (text fields), graphql:
rq.request.body.update({ mode: 'urlencoded', urlencoded: 'a=1&b=2' });

// Send without a body:
rq.request.body = null;

mode: 'file' is not supported: a script cannot choose local files to upload; the call is refused with a console warning and the body is left unchanged. On a body-less request rq.request.body is undefined, but assignment still works and creates the body. Example (reading):

console.log("Body:", rq.request.body.toString());

`rq.request.url`

The request URL as a Url object, the same shape as Postman’s pm.request.url. It converts to a string wherever one is expected ("Sending to " + rq.request.url, `${rq.request.url}`, new URL(String(rq.request.url))), and exposes the URL’s parts:

Property / method	Value for `https://api.example.com:8443/v1/users/42?page=2&tag=a#top`
`protocol`	`"https"`
`host`	`["api", "example", "com"]`
`port`	`"8443"`
`path`	`["v1", "users", "42"]`
`hash`	`"top"`
`query`	a list of query parameters — see below
`variables`	the request’s path variables (`variables.get("id")`)
`getHost()`	`"api.example.com"`
`getPath()`	`"/v1/users/42"`
`getQueryString()`	`"page=2&tag=a"`
`getPathWithQuery()`	`"/v1/users/42?page=2&tag=a"`
`getRemote()`	`"api.example.com:8443"`
`toString()`	the full URL

Example:

if (rq.request.url.path.includes("healthz") || rq.request.url.host.includes("localhost")) {
    console.log("Skipping auth for", rq.request.url.toString());
}

rq.request.url.query is a list of query parameters with the same API as Postman’s:

Read: get(name), has(name), one(name), count(), idx(i), indexOf(...), all(), each(fn), map(fn), filter(fn), find(fn), reduce(fn, initial), toString(). toObject() returns { name: value }; a repeated name becomes an array of values.
Change: add(param), insert(param, before), insertAfter(param, after), prepend(param), append(param), upsert(param), remove(name | fn), clear(), populate(list), repopulate(list), assimilate(list, prune). A param is { key, value } or a "key=value" string. rq.request.url.addQueryParams(...) and removeQueryParams(...) do the same in bulk.

rq.request.url.variables is the list of the request’s path variables (:id in the URL) with the same list API, plus replace("{{id}}"), substitute(object), syncFromObject(object), syncToObject(). You can also edit the URL parts directly: rq.request.url.path.push("v2"), rq.request.url.host = ["api", "example", "com"], rq.request.url.port = "8443", or rq.request.url.update("https://...") to replace the whole URL. In a pre-request script every one of these changes applies to the request that is sent, as in Postman. In a post-response script the request has already been sent.

rq.request.url.query.add({ key: "trace-id", value: rq.$guid() });
rq.request.url.path.push("v2");
console.log(rq.request.url.toString());

JSON.stringify(rq.request.url) returns the URL’s parts, the same shape Postman uses: { protocol, host: [...], port, path: [...], hash, query: [{ key, value }], variable: [...] }. Use rq.request.url.toString() when you want the URL as a string.

rq.request.url is an object, not a string, exactly as in Postman. typeof rq.request.url is "object", a strict comparison such as rq.request.url === "https://..." is false, and string methods like .split() or .includes() are not available on it. Call rq.request.url.toString() first: rq.request.url.toString().split("?"), rq.expect(rq.request.url.toString()).to.equal(...). Scripts written before this change that called a string method directly on rq.request.url need that one edit.

`rq.request.queryParams`

A read-only object mapping each query parameter name to its value ({ name: value }). Iterate it with Object.entries(). Example:

console.log("Query Params:", JSON.stringify(rq.request.queryParams));

Common Use Cases

Logging Request Details

console.log("Making " + rq.request.method + " request to " + rq.request.url);
console.log("Request headers:", JSON.stringify(rq.request.headers.all()));
console.log("Request body:", JSON.stringify(rq.request.body));

Conditional Logic Based on Request Method

if (rq.request.method === "POST" || rq.request.method === "PUT") {
    console.log("Sending data:", rq.request.body);
}

Accessing Query Parameters

Object.entries(rq.request.queryParams).forEach(([key, value]) => {
    console.log(`Query param ${key}: ${value}`);
});

Adding an Authentication Header

// In a pre-request script
const token = rq.environment.get("authToken");
if (token) {
    rq.request.headers.upsert({ key: "Authorization", value: "Bearer " + token });
}

Getting Started

API Design

Mock Server

Collaboration & Projects

Account & Administration

rq.request (Request object)

Properties and Methods

`rq.request.method`

`rq.request.headers`

`rq.request.headers.add(header)`

`rq.request.headers.upsert(header)`

`rq.request.headers.remove(name)`

`rq.request.headers.clear()`

`rq.request.body`

`rq.request.url`

`rq.request.queryParams`

Common Use Cases

Logging Request Details

Conditional Logic Based on Request Method

Accessing Query Parameters

Adding an Authentication Header

​Properties and Methods

​rq.request.method

​rq.request.headers

​rq.request.headers.add(header)

​rq.request.headers.upsert(header)

​rq.request.headers.remove(name)

​rq.request.headers.clear()

​rq.request.body

​rq.request.url

​rq.request.queryParams

​Common Use Cases

​Logging Request Details

​Conditional Logic Based on Request Method

​Accessing Query Parameters

​Adding an Authentication Header

​Related Documentation

Properties and Methods

`rq.request.method`

`rq.request.headers`

`rq.request.headers.add(header)`

`rq.request.headers.upsert(header)`

`rq.request.headers.remove(name)`

`rq.request.headers.clear()`

`rq.request.body`

`rq.request.url`

`rq.request.queryParams`

Common Use Cases

Logging Request Details

Conditional Logic Based on Request Method

Accessing Query Parameters

Adding an Authentication Header

Related Documentation