Feedback

Hi there, I've been struggling to get rest_command to work when using x-api-key in a POST operation. After many hours of searching and trying many different combinations, I finally found a solution, and would like to suggest an additional example for the documentation that might help others avoid the frustration I went through !
I found the only way to get x-api-key to work was to store it in the secrets file. Once I did this the API call worked. My code looks like this:

  powervault_set_override_status:
    url: "https://api.p3.powervault.co.uk/v3/unit/<unitID>/stateOverride"
    method: post
    headers:
      x-api-key: !secret powervault #name of the entry in the secrets.yaml file
      accept: "application/json"
      user-agent: 'Mozilla/5.0'
    content_type:  'application/json; charset=utf-8'
    payload: 
      '{"stateOverrides": [  {"start": "{{ start_time }}",
      "end": "{{ end_time }}",
      "state": "{{ new_state }}" } ] }'

It was also frustrating that I couldn't see what data was actually being sent to the API endpoint, even when I enabled debug logging it never showed the full request, specifically the headers. As I had to pass x-api-key in the header, I was unable to see if it was being formatted correctly. The API provider documented how it should appear, inlcuding examples using curl, but without being able to see what was being sent, I was guessing as to which part was wrong. I have seen posts from other people struggling with the same challenge. Apologies if this should be raised as a separate issue?

URL

https://www.home-assistant.io/integrations/rest_command/

Version

2025.2.5

Additional information

No response