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.

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

$rest = New-Object Chilkat.Rest

#  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 -eq $false) {
    $($rest.LastErrorText)
    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.
$rest.AddHeader("Accept","application/json")
$rest.AddHeader("X-Custom-Header","example-value")

$responseText = $rest.FullRequestNoBody("GET","/api/data")
if ($rest.LastMethodSuccess -eq $false) {
    $($rest.LastErrorText)
    exit
}

$($responseText)