Add a Request Header to a REST Request

See more REST Examples

Demonstrates Rest.AddHeader, which adds an HTTP request header field. The 1st argument is the field name and the 2nd is the value. Adding a header whose name already exists replaces the previous value.

require 'chilkat'

success = false

rest = Chilkat::CkRest.new()

#  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.
bTls = true
bAutoReconnect = true
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

#  Add request header fields.  The 1st argument is the field name and the 2nd is the value.
#  Adding a header with a name that already exists replaces the previous value.
rest.AddHeader("Accept","application/json")
rest.AddHeader("X-Custom-Header","example-value")

responseText = rest.fullRequestNoBody("GET","/api/data")
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

print responseText + "\n";