Setting Request Headers in Ruby

Question

I have the rest client gem and I am defining a request like this:

url = 'http://someurl'
request =  {"data" => data}.to_json
response = RestClient.post(url,request,:content_type => :json, :accept => :json)

However I need to set the HTTP header to something. For example an API key. Which could be done in curl as:

curl -XHEAD -H x-auth-user: myusername -H x-auth-key: mykey "url"

Whats the best way to do this in ruby? Using this gem? Or can I do it manually to have more control.

score 51 · Accepted Answer · edited Apr 21 '13 at 19:51

51

You can do what you want by:

response = RestClient.post( 
  url, 
  request,
  :content_type => :json, :accept => :json, :'x-auth-key' => "mykey")

edited Apr 21 '13 at 19:51

gene_wood

answered Aug 28 '12 at 14:40

6

`-` is no a valid caracter in for a `Symbol`. – Maurício Linhares Aug 28 '12 at 19:36
@MaurícioLinhares Actually, you can use :'x-auth-key' as a symbol, but not :x-auth-key . See: http://stackoverflow.com/questions/2134702/ruby-1-9-hash-with-a-dash-in-a-key – Magne Jan 12 '17 at 12:30

score 22 · Answer 2 · answered Nov 29 '13 at 06:46

22

You can also do this

RestClient::Request.execute(
   :method => :get or :post,
   :url => your_url,
   :headers => {key => value}
)

answered Nov 29 '13 at 06:46

rrrrong

extremely helpful, thanks, didnt see that :headers => {} in the docs – jpw Jun 09 '15 at 21:47

score 4 · Answer 3 · answered Nov 28 '14 at 11:00

I had the same problem with Rest-Client (1.7.2) I need to put both params and HTTP headers.

I solved with this syntax:

params = {id: id, device: device, status: status}
headers = {myheader: "giorgio"}

RestClient.put url, params, headers

I hate RestClient :-)

score 0 · Answer 4 · edited May 27 '16 at 15:34

0

If PUT isn't allowed we can pass it in the header of POST. Headers in bold. This worked for me:

act_resp = RestClient.post url, req_param, **:content_type => :json, :method => :put**

edited May 27 '16 at 15:34

armatita

answered May 26 '16 at 07:57

Serhii Aksiutin

4 Answers4