Sample code for 30+ languages & platforms
Delphi ActiveX

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.

Background. Request headers configured with AddHeader are applied to subsequent requests sent through the object, such as Accept, Content-Type, or custom application headers.

Chilkat Delphi ActiveX Downloads

Delphi ActiveX
var
success: Integer;
rest: TChilkatRest;
bTls: Integer;
bAutoReconnect: Integer;
responseText: WideString;

begin
success := 0;

rest := TChilkatRest.Create(Self);

//  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.
bTls := 1;
bAutoReconnect := 1;
success := rest.Connect('example.com',443,bTls,bAutoReconnect);
if (success = 0) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    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.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(rest.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add(responseText);