Post-response Scripts

Post-response scripts execute after receiving the HTTP response, allowing you to extract data, save variables, and process the response.

Available Objects

In post-response scripts, you have access to:

bru - Main Bruno API object
req - Request object (read-only)
res - Response object
test - Test function
expect / assert - Chai assertion libraries
console - Logging functions

Response Object (res)

The res object represents the HTTP response received from the server.

Properties

number

HTTP status code (e.g., 200, 404, 500)

string

HTTP status text (e.g., “OK”, “Not Found”)

object

Response headers as key-value pairs

any

Response body (automatically parsed if JSON)

number

Response time in milliseconds

string

Final URL after redirects

Methods

function

Returns the HTTP status code

const status = res.getStatus();
if (status === 200) {
  console.log('Request successful');
}

function

Returns the HTTP status text

const statusText = res.getStatusText();
// Returns: "OK"

function

Gets a specific response headerParameters:

name (string) - Header name

const contentType = res.getHeader('content-type');
const rateLimit = res.getHeader('x-rate-limit-remaining');

function

Returns all response headers as an object

const headers = res.getHeaders();
console.log('Response headers:', headers);

function

Returns the response body (automatically parsed if JSON)

const body = res.getBody();
console.log('User ID:', body.userId);

function

Modifies the response bodyParameters:

data (any) - New body data

// Modify response data
const body = res.getBody();
body.processed = true;
body.processedAt = Date.now();
res.setBody(body);

function

Returns the response time in milliseconds

const time = res.getResponseTime();
console.log(`Request took ${time}ms`);

if (time > 1000) {
  console.warn('Slow response detected');
}

function

Returns the final URL (useful after redirects)

const finalUrl = res.getUrl();

function

Returns size information about the responseReturns an object with:

header - Size of headers in bytes
body - Size of body in bytes
total - Total size in bytes

const size = res.getSize();
console.log(`Response size: ${size.total} bytes`);
console.log(`Headers: ${size.header} bytes, Body: ${size.body} bytes`);

function

Returns the raw response data as a Buffer

const buffer = res.getDataBuffer();
// Useful for binary data

function

Query the response body using dot notation (callable response)Parameters:

path (string) - Dot-notation path to query

// Instead of res.getBody().user.name
const userName = res('user.name');

// Query arrays
const firstItem = res('items[0].title');

Bruno Object (bru)

The bru object provides the main Bruno API for managing variables, environment, and request flow.

Variable Management

Runtime Variables

Runtime variables exist only during the current request/collection run.

function

Sets a runtime variable

bru.setVar('userId', 123);
bru.setVar('token', 'abc123');

function

Gets a runtime variable (with interpolation)

const userId = bru.getVar('userId');

function

Checks if a runtime variable exists

if (bru.hasVar('userId')) {
  console.log('User ID is set');
}

function

Deletes a runtime variable

bru.deleteVar('userId');

function

Returns all runtime variables

const allVars = bru.getAllVars();
console.log('Runtime vars:', allVars);

function

Deletes all runtime variables

bru.deleteAllVars();

Environment Variables

Environment variables are associated with the selected environment.

function

Sets an environment variableParameters:

key (string) - Variable name
value (string) - Variable value
options.persist (boolean) - If true, saves to environment file

// Temporary (in-memory only)
bru.setEnvVar('session_token', token);

// Persistent (saved to file)
bru.setEnvVar('api_key', key, { persist: true });

When persist: true, only string values are allowed. Non-string values will throw an error.

function

Gets an environment variable

const apiKey = bru.getEnvVar('api_key');

function

Checks if an environment variable exists

if (bru.hasEnvVar('api_key')) {
  // Use API key
}

function

Deletes an environment variable

bru.deleteEnvVar('old_token');

function

Returns all environment variables (excluding __name__)

const envVars = bru.getAllEnvVars();

function

Deletes all environment variables

bru.deleteAllEnvVars();

function

Returns the name of the active environment

const envName = bru.getEnvName();
console.log('Current environment:', envName);

Global Environment Variables

Global environment variables are shared across all environments.

function

Sets a global environment variable

bru.setGlobalEnvVar('base_url', 'https://api.example.com');

function

Gets a global environment variable

const baseUrl = bru.getGlobalEnvVar('base_url');

function

Deletes a global environment variable

function

Returns all global environment variables

function

Deletes all global environment variables

Collection Variables

Collection-level variables defined in collection settings.

function

Sets a collection variable

bru.setCollectionVar('version', 'v2');

function

Gets a collection variable

const version = bru.getCollectionVar('version');

function

Checks if a collection variable exists

function

Deletes a collection variable

function

Returns all collection variables

function

Deletes all collection variables

Folder & Request Variables

Read-only access to folder and request-level variables.

function

Gets a folder-level variable

const folderVar = bru.getFolderVar('folder_setting');

function

Gets a request-level variable

const requestVar = bru.getRequestVar('request_setting');

OAuth2 Credentials

function

Gets an OAuth2 credential variable

const accessToken = bru.getOauth2CredentialVar('$oauth2.my-credential.access_token');

function

Resets OAuth2 credentials (clears access/refresh tokens)Parameters:

credentialId (string) - The credential ID to reset

bru.resetOauth2Credential('my-credential');

Request Flow Control

function

Skips the current request (only in collection runs)

script:pre-request {
  if (bru.getEnvVar('skip_auth_requests')) {
    bru.runner.skipRequest();
  }
}

function

Stops the entire collection run

script:post-response {
  if (res.getStatus() === 401) {
    console.log('Authentication failed, stopping execution');
    bru.runner.stopExecution();
  }
}

function

Sets the next request to execute in a collection runParameters:

requestName (string) - Name of the next request to run

script:post-response {
  if (res.getBody().requiresVerification) {
    bru.setNextRequest('verify-email');
  } else {
    bru.setNextRequest('complete-signup');
  }
}

Utility Functions

function

Interpolates variables in a string or object

const url = bru.interpolate('https://{{host}}/api/{{version}}/users');
// Returns: "https://api.example.com/api/v1/users"

function

Returns the collection directory path

const collectionPath = bru.cwd();
console.log('Collection location:', collectionPath);

function

Returns the collection name

const name = bru.getCollectionName();

function

Gets a process environment variable from the OS

const home = bru.getProcessEnv('HOME');
const path = bru.getProcessEnv('PATH');

function

Pauses execution for the specified millisecondsParameters:

ms (number) - Milliseconds to sleep

Returns a Promise.

await bru.sleep(1000); // Wait 1 second

function

Returns true if running in safe mode (QuickJS runtime)

if (bru.isSafeMode()) {
  console.log('Running in safe mode');
} else {
  console.log('Running in Node VM mode');
}

function

Creates a cookie jar instance for managing cookies

const jar = bru.cookies.jar();

// Set a cookie
jar.setCookie('https://example.com', 'sessionId', 'abc123', (err) => {
  if (err) console.error(err);
});

// Get a cookie
jar.getCookie('https://example.com', 'sessionId', (err, cookie) => {
  if (!err) {
    console.log('Cookie:', cookie.value);
  }
});

// Get all cookies for a URL
jar.getCookies('https://example.com', (err, cookies) => {
  if (!err) {
    console.log('All cookies:', cookies);
  }
});

// Check if cookie exists
jar.hasCookie('https://example.com', 'sessionId', (err, exists) => {
  console.log('Cookie exists:', exists);
});

// Delete a cookie
jar.deleteCookie('https://example.com', 'sessionId', (err) => {
  console.log('Cookie deleted');
});

// Delete all cookies for a URL
jar.deleteCookies('https://example.com', (err) => {
  console.log('All cookies deleted for domain');
});

// Clear entire jar
jar.clear((err) => {
  console.log('All cookies cleared');
});

Utility Methods

function

Minifies JSON (removes whitespace)Parameters:

json (string | object) - JSON to minify

const minified = bru.utils.minifyJson({
  name: 'John',
  age: 30
});
// Returns: '{"name":"John","age":30}'

function

Minifies XML (removes whitespace)Parameters:

xml (string) - XML string to minify

const minified = bru.utils.minifyXml('<root>  <item>value</item>  </root>');

Test Results

async function

Returns all test results with summary

const results = await bru.getTestResults();
console.log(`Passed: ${results.summary.passed}`);
console.log(`Failed: ${results.summary.failed}`);

async function

Returns all assertion results with summary

const results = await bru.getAssertionResults();
console.log('Assertion results:', results);

Common Patterns

Extract and Save Data

script:post-response {
  const body = res.getBody();
  
  // Save authentication token
  if (body.token) {
    bru.setEnvVar('auth_token', body.token);
  }
  
  // Save user ID for next request
  if (body.userId) {
    bru.setVar('current_user_id', body.userId);
  }
  
  // Save to collection variable
  if (body.apiVersion) {
    bru.setCollectionVar('api_version', body.apiVersion);
  }
}

Chain Requests

script:post-response {
  const status = res.getStatus();
  const body = res.getBody();
  
  if (status === 201 && body.id) {
    // User created, now verify email
    bru.setVar('new_user_id', body.id);
    bru.setNextRequest('send-verification-email');
  } else if (status === 409) {
    // User exists, skip to login
    bru.setNextRequest('login-existing-user');
  }
}

Error Handling

script:post-response {
  if (res.getStatus() >= 400) {
    console.error('Request failed:', res.getStatus());
    console.error('Error:', res.getBody());
    
    // Stop collection run on auth errors
    if (res.getStatus() === 401) {
      bru.runner.stopExecution();
    }
  }
}

Response Transformation

script:post-response {
  const body = res.getBody();
  
  // Transform response data
  if (Array.isArray(body.items)) {
    body.itemCount = body.items.length;
    body.processedAt = new Date().toISOString();
    res.setBody(body);
  }
}

Bru Language

Scripting API

CLI Reference

Post-response Scripts

Available Objects

Response Object (res)

Properties

Methods

Bruno Object (bru)

Variable Management

OAuth2 Credentials

Request Flow Control

Utility Functions

Utility Methods

Test Results

Common Patterns

Extract and Save Data

Chain Requests

Error Handling

Response Transformation

Next Steps

Test API

Pre-request Scripts

​Available Objects

​Response Object (res)

​Properties

​Methods

​Bruno Object (bru)

​Variable Management

​OAuth2 Credentials

​Request Flow Control

​Utility Functions

​Cookie Management

​Utility Methods

​Test Results

​Common Patterns

​Extract and Save Data

​Chain Requests

​Error Handling

​Response Transformation

​Next Steps

Test API

Pre-request Scripts

Available Objects

Response Object (res)

Properties

Methods

Bruno Object (bru)

Variable Management

OAuth2 Credentials

Request Flow Control

Utility Functions

Cookie Management

Utility Methods

Test Results

Common Patterns

Extract and Save Data

Chain Requests

Error Handling

Response Transformation

Next Steps