Check response header's value in Postman tests

Question

I would like to check the value from a concrete response header ("Location") as Test Results in Postman. In the Postman's documentation I found examples of how to check the existance of headers with

pm.test("Content-Type is present", function () {
   pm.response.to.have.header("Content-Type");
});

But what I'm looking for is something like

pm.test("Location value is correct", function () {
   CODE HERE THAT CHECKS "Location" HEADER EQUALS TO SOMETHING;
});

score 94 · Accepted Answer · answered Mar 13 '18 at 10:17

94

I finally found the solution:

pm.test("Redirect location is correct", function () {
   pm.response.to.have.header("Location");
   pm.response.to.be.header("Location", "http://example.com/expected-redirect-url");
});

answered Mar 13 '18 at 10:17

Lluís Suñol

3,466
3
22
33

2

Sandbox you very much! – Piotr Kula Nov 22 '18 at 13:30
2

you're sandbox! :) – Lluís Suñol Nov 23 '18 at 10:32
2

With Postman v7.35.0, remember to turn off _Automatically follow redirects_ in Settings to see the Redirect response. – chy600 Nov 10 '20 at 17:52
You could also use just the line `pm.response.to.have.header("Location", "http://example.com/expected-redirect-url");` – YGautomo May 16 '23 at 10:46

score 21 · Answer 2 · answered Sep 15 '19 at 10:04

Here is another way of fetching the specific response header in Tests section ...

loc = pm.response.headers.get("Location");

Just in case, if the subsequent request(s) need the specific info, like header value, then you can also store/set it as environment variable as below, and reuse further

pm.environment.set("redirURL", loc);

var loc = null;
pm.test("Collect redirect location", function () {
   pm.response.to.have.header("Location");
   loc = pm.response.headers.get("Location");
   if (loc !== undefined) {
      pm.environment.set("redirURL", loc);
   }
});

The advantage is - the value collected in the variable can be manipulated.

But it all depends on the situation. Like, you might want to extract and pre/post-process the redirect URL.

For example,

While running the test collection, you would like to collect the value in a variable and change it to point to the mock server's host:port.

score 1 · Answer 3 · answered Jul 03 '20 at 06:34

HeadersList has the method has(item, valueopt) → {Boolean}, so easiest way to check the header is:

const base_url = pm.variables.get("base_url")

pm.test("Redirect to OAuth2 endpoint", () => {
    pm.expect(pm.response.headers.has("Location",`${base_url}/oauth2/`)).is.true
})

score 0 · Answer 4 · answered Apr 06 '21 at 12:19

0

pm.test("Location value is correct", function () {
   pm.expect(pm.response.headers.get('Location')).to.eql('http://google.com');
});

answered Apr 06 '21 at 12:19

Vallabha Vamaravelli

1,153
1
9
15

score 0 · Answer 5 · answered Apr 13 '21 at 10:32

Postman also supports ES6/ES2015 syntax as well, allowing us to use arrow functions.

So here's how a simple test to verify that the common response headers are present:

pm.test("Verify response headers are present ", () => {
    pm.response.to.have.header("Date");
    pm.response.to.have.header("Content-Length");
    pm.response.to.have.header("Content-Type");
});

Of course, you can check for any custom headers you may have returned by your API.

score 0 · Answer 6 · answered Jul 06 '21 at 08:22

0

Using the BDD expect/should style:

pm.test("Redirect location is correct", () => {
   pm.expect(pm.response).to.include.header("Location");
   pm.expect(pm.response).to.have.header("Location", "http://example.com/expected-redirect-url");
});

answered Jul 06 '21 at 08:22

rmuller

12,062
4
64
92

Check response header's value in Postman tests

6 Answers6