Passing API key with HTTP header in cURL

Question

I have an API Proxy in Apigee which is authenticated with an API key. I'm passing the key with my HTTP request header using cURL, with this command:

curl -v -H "apikey: my_key" http://api_org-test.apigee.net/v1/helloapikey

I get this error:

Invoke-WebRequest : Cannot bind parameter 'Headers'. Cannot convert the 
"apikey: my_key" value of type "System.String" to 
type "System.Collections.IDictionary".

When I modify my policy to look for the key in query parameter rather than the header, it works fine. Am I missing something here?

score 33 · Accepted Answer · answered Nov 28 '16 at 06:15

33

Try this:

curl -v -H @{'apikey' = 'my_key'} http://api_org-test.apigee.net/v1/helloapikey

Note: curl is an alias for the Invoke-WebRequest cmdlet:

Get-Alias curl

output:

CommandType     Name
-----------     ----
Alias           curl -> Invoke-WebRequest

answered Nov 28 '16 at 06:15

Martin Brandl

47,498
11
97
129

For multiple headers, multiple `-H` does not work, you need to use `-H @{'Cookies' = 'examplecookie=examplevalue'; 'Authorization: example'}` – Luc Apr 22 '20 at 15:24

score 9 · Answer 2 · answered Mar 08 '18 at 16:47

9

You could install curl: https://stackoverflow.com/a/16216825/3013633

Remove existing curl alias by executing this command:

Remove-item alias:curl

Then your command will work:

curl -v -H "apikey: my_key" http://api_org-test.apigee.net/v1/helloapikey

answered Mar 08 '18 at 16:47

iaforek

1,906
2
27
45

2

In my case curl was already installed. Only had to remove alias. – Joakim Poromaa Helger Feb 26 '19 at 09:27

score 2 · Answer 3 · answered Jan 06 '20 at 00:11

2

None of the above answers worked for me (I got an error -- parse error near }).

This worked:

curl -X GET \
  'http://api_org-test.apigee.net/v1/helloapikey' \
  -H 'apikey: my_key'

answered Jan 06 '20 at 00:11

him229

935
1
7
18

@him299 How can I add this on a curl script. using Php? – Naveenbos Mar 27 '20 at 14:26

score 1 · Answer 4 · edited Jan 26 '21 at 08:45

1

PowerShell simply does not resolve the variable within your URL. You are trying to query the service at the URI http://$serverHost:1234/service which won't work. You could do

$serverHost = "myHost"
$service = "http://$serverHost`:1234/service"
Invoke-WebRequest $service -Method Get

edited Jan 26 '21 at 08:45

Yatin

2,348
6
20
38

answered Nov 28 '16 at 06:23

user1012506

1,831
19
36

score 0 · Answer 5 · answered Sep 12 '18 at 14:26

Just to add this to the discussion, I had to both hash the api key, but leave the token call key phrase rather than change it to 'apikey'. That's just what worked for me!

curl -v -H @{'X-API-TOKEN' = '[*insert key here*]'} '*datacenter_url*)'

Also noteworthy to PowerShell newcomers, -v stands for verbose. This switch gives you a Cyan-colored text under the command in PowerShell ise about the command PS is running. Almost like a play-by-play commentary. Useful enough I thought I'd mention it.

Passing API key with HTTP header in cURL

5 Answers5