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.

load ./chilkat.dll

set success 0

set rest [new_CkRest]

#  Connect to the REST server.  The 3rd argument enables TLS (use 1 for HTTPS on port 443),
#  and the 4th enables automatic reconnection if the connection is dropped between requests.
set bTls 1
set bAutoReconnect 1
set success [CkRest_Connect $rest "example.com" 443 $bTls $bAutoReconnect]
if {$success == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

#  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.
CkRest_AddHeader $rest "Accept" "application/json"
CkRest_AddHeader $rest "X-Custom-Header" "example-value"

set responseText [CkRest_fullRequestNoBody $rest "GET" "/api/data"]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

puts "$responseText"

delete_CkRest $rest