Request Object

The HTTP method of the incoming request. This is a read-only string value.

// GET /search?q=something 
request.method 
// => "GET"

The scheme of the incoming request ("http" or "https"). This is a read-only string value.

// https://www.example.com/search?q=something
request.scheme
// => "https"

The host header value of the incoming request. This is a read-only string value.

// Host: www.example.com 
request.host   
// => "www.example.com"

The URL path of the incoming request, including the filename and extension, but without any query string. This is a read-only string value.

// https://www.example.com/search?q=something
request.path 
// => "/search"

The query string of the incoming request. This is a read-only string value.

// GET /search?q=something
request.query
// => "q=something"

The relative path and query string of the incoming request. This is a read-only string value.

// https://www.example.com/search?q=something
request.url  
// => "/search?q=something"

A unique identifier in the form of an unsigned integer that is used for reporting site traffic usage data. This is a read-only value.

// Request cpCode 12345
 request.cpCode 
// => 12345

Returns the object that contains properties specifying the geographic location.

For more information see the User Location Object .

Returns information that specifies client device characteristics.

For more information see the Device Object.

Returns the methods that specify the HTTP response in cache for an HTTP request.

For more information see the cacheKey Object.

Constructs a response for the given request, rather than fetching a response from cache or the origin.

// generate an empty API response
request.respondWith(200, {'Content-Type': ['application/json;charset=utf-8']  }, '{}');
// => {}

// generate a denied API response
request.respondWith(403, {'Content-Type': ['application/json;charset=utf-8']  }, '{}', 'Denied Response');
// => {} 

Renames or adds values to a header. If the header already exists, then the value is appended. The new header value can be a single string or an array. Request headers can only be modified during the onClientRequest and onOriginRequest events.

Review the table for information about the possible arguments.

//
request.addHeader('HeaderName', 'HeaderValue');
// HeaderName: HeaderValue

Returns an array of header values by header name. The header names are case insensitive. If the header doesn’t exist, an undefined array is returned. Request headers can only be modified during onClientRequest and onOriginRequest events.

Review the table for information about the possible arguments.

// User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:66.0) Gecko/20100101 Firefox/66.0
request.getHeader('User-Agent')[0];
// => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:66.0) Gecko/20100101 Firefox/66.0"

Returns a JavaScript object that contains all HTTP request headers as properties.

The key for each property is the name of the HTTP header, normalized to lower-case. The value is an array of strings, containing one string for each HTTP header with the same name.

This request header can only be modified during the responseProvider event.

import { httpRequest } from 'http-request';
import { createResponse } from 'create-response';
 
export function responseProvider(request) {
    let hdrs = request.getHeaders();
    httpRequest('/header-collector', {headers: hdrs});
 
    //...
}

Sets header values and overrides any previous headers. Request headers can only be modified during the onClientRequest and onOriginRequest events.

Review the table for information about the possible arguments.

// Referer: http://www.example.com
request.setHeader('Referer', 'http://www.akamai.com');
// Referer: http://www.akamai.com

Removes the named header. Request headers can only be modified during onClientRequest and onOriginRequest events. The header name is case insensitive.

Review the table for information about the possible arguments.

// Pragma: HeaderName
request.removeHeader('Pragma');
//

Gets the value of a Property Manager user-defined variable. Only variables that start with a PMUSER prefix are available.

Review the table for information about the possible arguments.

request.getVariable('PMUSER_MYVARIABLE');
// => "MyVariableValue"

Sets the value of a Property Manager user-defined variable. Only variables that start with a PMUSER prefix are available. For more information see User-defined variables.

Review the table for information about the possible arguments.

// PMUSER_MyVariable = "MyValue"
request.setVariable('PMUSER_MyVariable',’MyNewValue’);
// => PMUSER_MyVariable = "MyNewValue"

Routes the outbound origin request to a predefined origin server, a modified path, or a modified query string. The destination must be a JavaScript object containing at least one of the following optional properties; path, query, or origin. If the destination is not a JavaScript object an error is thrown. Can only be modified during the onClientRequest event.

// GET /search?q=something
request.route({origin: "origin-1", path: "/example.html", query: "a=1&b=2"}); 
// GET /example.html?a=1&b=2