How to pass custom API key headers (e.g., DOLAPIKEY) for authentication?

[rahilmehta-dev]

I'm trying to test the Dolibarr API which requires a custom DOLAPIKEY header for authentication. I'm not sure if I'm configuring AutoRestTest correctly or if this is currently supported.
The Dolibarr API needs the DOLAPIKEY header to be passed with every request

What I've Tried

1. Enabled the Header Agent in configurations.toml:

[agents.header]
 enabled = true

2. However, the documentation states that the Header Agent only supports Basic Authentication (username/password), not custom API keys.

My Questions

1. Is there a way to pass custom API key headers through configuration without modifying the code?
2. Should I be using a different approach or configuration?

If you need the spec file, I can share it. Any guidance would be appreciated!

[tylerstennett]

Hello Rahil!

Thanks for raising this issue. You're right that there wasn't an easy way to add custom headers through configuration alone — we had some workarounds at the network layer, but better configuration support was definitely needed.

This has been addressed in commit 5d5c0a7 (accessible in the main branch). You can now configure custom headers directly in configurations.toml. Please refer to the updated configuration file for instructions on adding your DOLAPIKEY header, including guidance on using environment variables via .env for convenience.

As you noted, the Header Agent is specifically designed for Bearer token authentication and won't help in this case. The new custom headers configuration should be a better fit for API keys like Dolibarr's.

I've closed this issue as resolved, but feel free to reopen if you run into any problems!