httpx on Grafana Labs

asyncRequest(method, url, [body], [params])

Mon, 21 Sep 2026 15:16:28 +0000

asyncRequest(method, url, [body], [params])

Generic method for making arbitrary asynchronous HTTP requests. Note, this method returns a Promise. You must use the await keyword to resolve it.

Parameter	Type	Description
method	string	HTTP method. Must be uppercase (GET, POST, PUT, PATCH, OPTIONS, HEAD, etc)
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
Promise with Response	HTTP Response object.

Example

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

const session = new Httpx({
  baseURL: 'https://quickpizza.grafana.com/api',
  timeout: 20000, // 20s timeout.
});

export default async function testSuite() {
  const resp_get = await session.asyncRequest('GET', `/status/200`);
  const resp_post = await session.asyncRequest('POST', `/status/200`, { key: 'value' });
  const resp_put = await session.asyncRequest('PUT', `/status/200`, { key: 'value' });
  const resp_patch = await session.asyncRequest('PATCH', `/status/200`, { key: 'value' });
  const resp_delete = await session.asyncRequest('DELETE', `/status/200`);

  // specific methods are also available.
  const respGet = await session.asyncGet(`/status/200`);
  const respPost = await session.asyncPost(`/status/200`, { key: 'value' });
  const respPut = await session.asyncPut(`/status/200`, { key: 'value' });
  const respPatch = await session.asyncPatch(`/status/200`, { key: 'value' });
  const respDelete = await session.asyncDelete(`/status/200`);
}

request(method, url, [body], [params])

Mon, 21 Sep 2026 15:16:28 +0000

request(method, url, [body], [params])

Generic method for making arbitrary HTTP requests.

Consider using specific methods for making common requests get, post, put, patch.

Parameter	Type	Description
method	string	HTTP method. Must be uppercase (GET, POST, PUT, PATCH, OPTIONS, HEAD, etc)
url	string	HTTP URL. If baseURL is set, provide only path.
body (optional)	null / string / object / ArrayBuffer / SharedArray	Request body; objects are `x-www-form-urlencoded`. To omit body, set to `null`.
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://quickpizza.grafana.com/api',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp_get = session.request('GET', `/status/200`);
  const resp_post = session.request('POST', `/status/200`, { key: 'value' });
  const resp_put = session.request('PUT', `/status/200`, { key: 'value' });
  const resp_patch = session.request('PATCH', `/status/200`, { key: 'value' });
  const resp_delete = session.request('DELETE', `/status/200`);
}

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

Mon, 21 Sep 2026 15:16:28 +0000

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

session.get(url, body, params) makes a GET request. Only the URL parameter is required

Parameter	Type	Description
url	string	HTTP URL. If baseURL is set, provide only path.
body (optional)	null / string / object / ArrayBuffer / SharedArray	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://quickpizza.grafana.com',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.get(`/api/names`);
}

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

Mon, 21 Sep 2026 15:16:28 +0000

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

Parameter	Type	Description
url	string	HTTP URL. If baseURL is set, provide only path.
body (optional)	null / string / object / ArrayBuffer / SharedArray	Request body; objects are `x-www-form-urlencoded`. To omit body, set to `null` .
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://quickpizza.grafana.com',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.post(`/api/json`, {
    first_name: 'Mr',
    last_name: 'Croco',
  });
}

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

Mon, 21 Sep 2026 15:16:28 +0000

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

session.put(url, body, params) makes a PUT 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 are `x-www-form-urlencoded`. To omit body, set to `null`.
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://quickpizza.grafana.com/api',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.put(`/put`, {
    first_name: 'Mr',
    last_name: 'Croco',
    username: 'my user',
    password: 'my password',
  });
  console.log(resp.status);
}

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

Mon, 21 Sep 2026 15:16:28 +0000

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

session.patch(url, body, params) makes a PATCH 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 are `x-www-form-urlencoded`. To omit body, set to `null` .
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://quickpizza.grafana.com/api',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.patch(`/patch`, {
    first_name: 'Mr',
    last_name: 'Croco',
    username: 'my user',
    password: 'my password',
  });
}

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

Mon, 21 Sep 2026 15:16:28 +0000

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

session.delete(url, body, params) makes a DELETE request. Only the first parameter is required. Body is discouraged.

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://quickpizza.grafana.com/api',
  timeout: 20000, // 20s timeout.
});

export default function testSuite() {
  const resp = session.delete(`/delete`);
}

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

Mon, 21 Sep 2026 15:16:28 +0000

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

session.options(url, body, params) makes an OPTIONS 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 are `x-www-form-urlencoded`. To omit the body, set to `null`.
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://quickpizza.grafana.com',
  timeout: 20000, // 20s timeout.
});

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

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

Mon, 21 Sep 2026 15:16:28 +0000

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://quickpizza.grafana.com',
  timeout: 20000, // 20s timeout.
});

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

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

Mon, 21 Sep 2026 15:16:28 +0000

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

session.trace(url, body, params) makes a TRACE 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://quickpizza.grafana.com',
  timeout: 20000, // 20s timeout.
});

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

batch( requests )

Mon, 21 Sep 2026 15:16:28 +0000

batch( requests )

Batch multiple HTTP requests together, to issue them in parallel over multiple TCP connections.

Parameter	Type	Description
requests	array	An array containing requests, in string or object form
params (optional)	object	Additional parameters for all requests in the batch

Returns

Type	Description
array	An array containing Response objects.

Example

import { Httpx, Get } from 'https://jslib.k6.io/httpx/0.1.0/index.js';
import { describe } from 'https://jslib.k6.io/expect/0.0.4/index.js';

const session = new Httpx({ baseURL: 'https://quickpizza.grafana.com' });

session.addHeader('Authorization', 'token abcdef0123456789');

export default function () {
  describe('01. Fetch public ratings all at once', (t) => {
    const responses = session.batch(
      [new Get('/api/ratings/1'), new Get('/api/ratings/2'), new Get('/api/ratings/3')],
      {
        tags: { name: 'PublicRatings' },
      }
    );

    responses.forEach((response) => {
      t.expect(response.status)
        .as('response status')
        .toEqual(200)
        .and(response)
        .toHaveValidJson()
        .and(response.json('stars'))
        .as('rating stars')
        .toBeGreaterThan(0);
    });
  });
}

setBaseUrl( url )

Mon, 21 Sep 2026 15:16:28 +0000

setBaseUrl( url )

Parameter	Type	Description
baseURL	string	Base URL to be used for all requests issued in the session

Example

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

const session = new Httpx();

session.setBaseUrl('https://quickpizza.grafana.com');

export default function () {
  session.get('/api/names'); // baseUrl doesn't need to be repeated on every request
}

addHeader( key, value )

Mon, 21 Sep 2026 15:16:28 +0000

addHeader( key, value )

Parameter	Type	Description
name	string	Header name
value	string	Header value

Example

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

const session = new Httpx({ baseURL: 'https://quickpizza.grafana.com' });

session.addHeader('Authorization', 'token abcdef0123456789');

export default function () {
  session.get('/api/ratings');
}

addHeaders( object )

Mon, 21 Sep 2026 15:16:28 +0000

addHeaders( object )

Parameter	Type	Description
headers	object	Object

Example

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

const session = new Httpx();

session.addHeaders({
  'Authorization': 'token abcdef0123456789',
  'User-Agent': 'My custom user agent',
});

export default function () {
  session.get('https://quickpizza.grafana.com/api/ratings');
}

clearHeader( name )

Mon, 21 Sep 2026 15:16:28 +0000

clearHeader( name )

Parameter	Type	Description
name	string	Header name to be removed

Example

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

const session = new Httpx({ headers: { Authorization: 'token1' } });

session.clearHeader('Authorization'); // removes header set in the constructor

export default function () {
  session.get('https://quickpizza.grafana.com');
}

addTag( key, value )

Mon, 21 Sep 2026 15:16:28 +0000

addTag( key, value )

Parameter	Type	Description
name	string	Tag name
value	string	Tag value

Example

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

const session = new Httpx({ baseURL: 'https://quickpizza.grafana.com' });

session.addTag('tagName', 'tagValue');
session.addTag('AnotherTagName', 'tagValue2');

export default function () {
  session.get('/');
}

addTags( object )

Mon, 21 Sep 2026 15:16:28 +0000

addTags( object )

Parameter	Type	Description
headers	object	Object

Example

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

const session = new Httpx();

session.addTags({
  Tag1: 'value1',
  Tag2: 'value2',
  Tag3: 'value3',
});

export default function () {
  session.get('https://quickpizza.grafana.com');
}

clearTag( name )

Mon, 21 Sep 2026 15:16:28 +0000

clearTag( name )

Parameter	Type	Description
name	string	Tag name to be removed

Example

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

const session = new Httpx({ tags: { tagName: 'tagValue' } });

session.clearTag('tagName'); // removes tag set in the constructor

export default function () {
  session.get('https://quickpizza.grafana.com');
}