Scripting

// Import UUID addons
const { uuidv4 } = require("@addons/UUID.js");
​
///
/// This func is called if the Request Checkbox is Enabled
/// You can manipulate the Request Data here before the request hits on the server
/// Ex: Add/Update/Remove HTTP Header, Query, Form, Body, Host, Port, Path
/// Use console.log(request) to see all available fields
///
function onRequest(context, url, request) {
  // print log
  console.log(request);
​
  // Change Production domain -> Localhost
  request.method = "GET";
  request.scheme = "http";
  request.host = "localhost";
  request.port = 8000;
  
  // Add new header
  request.headers["X-New-Header"] = "Hello From Scripting feature";
  request.headers["UUID"] = uuidv4(); // generate random UUIDv4
  delete request.headers["Key-Need-Delete"];
​
  // Update or Add a new Query
  request.queries["name"] = "Proxyman";
​
  // Update Body
  var body = request.body;
  body["name"] = "Proxyman";
  request.body = body;
  
  // Or Map the body with a local file (Proxyman 2.25.0+)
  // request.bodyFilePath = "~/Desktop/mockdata.json";
  
  // Done
  return request;
}

// context (readonly)
{
    "scriptName": "<String> Your Script Name",
    "matchingRule": "<String> Your Matching Rule",
    "matchingMethod": "<String> Method",
    "isEnableOnRequest": "Bool",
    "isEnableOnResponse": "Bool",
    "filePath": "<String> Script path",
    "flow": { // Availble from 2.16.0+
        "serverPort": "443",
        "serverIpAddress": "104.18.230.83",
        "clientIpAddress": "192.168.0.102",
        "remoteDeviceName": "iPhone XR",
        "remoteDeviceIP": "192.168.0.102",
        "id": "51",
        "clientPath": null,
        "clientPort": "51494",
        "clientName": null
    },
}
​
// url (readonly)
url: String // => Present the full URL
​
// request
{
    "method": "<String> HTTP Method. Accept string method. Ex: GET, POST, ...",
    "scheme": "<String> Accept http or https",
    "host": "<String> Host of the request. Ex: api.proxyman.io, localhost, ...",
    "path": "<String>: Path of the URL. Ex: /v1/data",
    "port": "<Int> Accept int port number. Ex: 443, 8080, ..",
    "queries": "<[String: Any]> A JS Object (Dictionary) contains key values of the query",
    "headers": "<[String: Any]> A JS Object (Dictionary) contains key values of the header",
    "body": "Depend on the Content-Type header. It might be a dictionary for JSON and form, Plain Text or Base64 Encoded String",
    "bodyFilePath": "<String><Optional> Set a body with a local file. See example in Snippet Code Page"
    "rawBody": "<Readonly>: A raw body String or Base64 encoded string if it's a binary",
    "preserveHostHeader": "<Bool> Preserve the Host",
    "isURLEncoding": "<Bool> Determine if Proxyman will perform URLEncoding when constructing the final URL. Default is True"
}
​

///
/// This func is called if the Response Checkbox is Enabled
/// You can manipulate the Response Data here before it goes to the client
/// Ex: Add/Update/Remove HTTP Header, Status, Body,...
/// Use console.log(response) to see all available fields
///
function onResponse(context, url, request, response) {
  console.log(response);
​
  // Update or Add a new header
  response.headers["Content-Type"] = "application/json";
​
  // Update status Code
  response.statusCode = 500;
​
  // Update Body
  var body = response.body;
  body["new-key"] = "Proxyman";
  response.body = body;
​
  // Or Map the body with a local file (Proxyman 2.25.0+)
  // response.bodyFilePath = "~/Desktop/mockdata.json";
  
  // Done
  return response;
}

// context (readonly): Same with onRequest
​
// url (readonly): Same with onRequest
​
// request (readonly): Same with onRequest
​
// response
{
    "statusCode": "<Int> Status Code. Ex: 200, 400, 404,...",
    "httpVersion": "<String><Readonly> The HTTP Version",
    "statusPhrase": "<String><Readonly> HTTP Status Phrase. Ex Not Found, OK, ...",
    "headers": "<[String: Any]> A JS Object (Dictionary) contains key values of the header",
    "body": "Depend on the Content-Type header. It might be a dictionary for JSON and form, PlainText or Base64 Encoded String",
    "rawBody": "<Readonly>: A raw body String or Base64 encoded string if it's a binary",
    "bodyFilePath": "<String><Optional> Set a body with a local file. See example in Snippet Code Page"
}

// Your binary, Uint8Array, blob data,...
var myData = fromFile();
​
// Import
const { btoa } = require('@addons/Base64.js');
​
// Convert to base64 encoded string
response.body = btoa(myData);