This is documentation for the next version of K6. For the latest stable release, go to the latest version.

Documentation

head(url, [body], [params])

Open source

head(url, [body], [params])

session.head(url, body, params) makes a HEAD request. Only the first parameter is required

Parameter	Type	Description
url	string	HTTP URL. If baseURL is set, provide only path.
body (optional)	null / string / object / ArrayBuffer / SharedArray	Request body; objects will be `x-www-form-urlencoded`. Set to `null` to omit the body.
params (optional)	null or object {}	Additional parameters for this specific request.

Returns

Type	Description
Response	HTTP Response object.

Example

import { Httpx } from 'https://jslib.k6.io/httpx/0.1.0/index.js';

const session = new Httpx({
  baseURL: 'https://httpbin.test.k6.io',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.head(`/head`);
  console.log(resp.status);
}