JavaScript

Remove a Request Header from a REST Request

Demonstrates Rest.RemoveHeader, which removes all request headers matching the supplied name.

Background. Removing a header is useful when reusing a Rest object across requests that require different header sets.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

var rest = new CkRest();

//  Connect to the REST server.  The 3rd argument enables TLS (use true for HTTPS on port 443),
//  and the 4th enables automatic reconnection if the connection is dropped between requests.
var bTls = true;
var bAutoReconnect = true;
success = rest.Connect("example.com",443,bTls,bAutoReconnect);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

rest.AddHeader("Accept","application/json");
rest.AddHeader("X-Custom-Header","example-value");

//  Remove a previously added request header by name.
rest.RemoveHeader("X-Custom-Header");

var responseText = rest.FullRequestNoBody("GET","/api/data");
if (rest.LastMethodSuccess == false) {
    console.log(rest.LastErrorText);
    return;
}

console.log(responseText);