Passing API key with HTTP header in cURL

powershell curl apigee
kuk_94 picture kuk_94 · Nov 28, 2016 · Viewed 50.2k times · Source

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?

Answer

Martin Brandl picture Martin Brandl · Nov 28, 2016

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

Related questions

PowerShell's Invoke-RestMethod equivalent of curl -u (Basic Authentication)

What is the equivalent of curl -u username:password ... in PowerShell's Invoke-RestMethod? I tried this: $securePwd = ConvertTo-SecureString "password" -AsPlainText -Force $credential = New-Object System.Management.Automation.PSCredential ($username, $securePwd) Invoke-RestMethod -Credential $credential ... but it returns 401, Unauthorized.

Read More
Script to use Google Image Search with local image as input

I'm looking for a batch or Powershell script to search for similar images on Google images using a local image as input. My research so far The syntax for a image search using a URL rather than a local file …

Read More
powershell curl and WebRequest both follow redirects

I was trying to figure out the status code returned by my webpage, which most certainly is 301 (moved permanently), according to curl on the Linux subsystem, but using curl or the WebRequest object on powershell, it returns 200 (OK). Why is …

Read More