Best way to get to know success/failure of API Execute calls?

[Getslow6]

Hi,

I've phrased the question in a generic way, but to elaborate:

I'm using the API to execute the DeployStack function from Home Assistant. This works, but the response is always of the form:

  content:
    operation: DeployStack
    start_ts: 1753182305019
    success: true
    operator: 687f58910f0e5f17fd45229a
    target:
      type: Stack
      id: 68512e65c91e7f95ae74d00d
    logs: []
    end_ts: null
    status: InProgress
  status: 200

This response is given even when the function fails, e.g.:

 whoami Pulling 
 whoami Error manifest for traefik/whoami:v1.1.0 not found: manifest unknown: manifest unknown
Error response from daemon: manifest for traefik/whoami:v1.1.0 not found: manifest unknown: manifest unknown

I've looked at alerters, but these only cover 'alerts' while the error message above is classified as an 'update' within Komodo.

Is there a way to notify Home Assistant of a failed 'DeployStack'?

[mbecker20]

Execute call will return immediately with the current update data, including update id, before the execute call actually runs. So it gives status: InProgress.

For code to get when the Execution finishes, there are two ways.

1. Easier. Take the update _id from the initial response, and poll GetUpdate using this update id. Check for status: Complete, and when it is complete look for failure: true

2. Subscribe to Update websocket, and receive updates in real time. You can filter the stream to anything you care about, and have the program take action like send alert under whatever situation you can code.

[Getslow6]

Thanks for the answer!

I have looked into both:

1. Is it correct that the response does not include an id? The docs indeed mention an ID, but I don't see it in the response. I've also double checked it by calling it from the command line in Windows:

C:\>curl --header "Content-Type: application/json" ^
More?      --header "X-Api-Key: K-aOmwm99TA<<<>>>>>OHaU0uns" ^
More?      --header "X-Api-Secret: S-8QEBfWpMi<<<<>>>>>bZ9SwVLaft4IGIjMEsgL" ^
More?      --data "{\"type\":\"DeployStackIfChanged\",\"params\":{\"stack\":\"whoami\"}}" ^
More?      https://komodo.mydomain.org/execute
{"operation":"DeployStack","start_ts":1753256728521,"success":true,"operator":"687f58910f0e5f17fd45229a","target":{"type":"Stack","id":"684fd6497075653bcb6a8411"},"logs":[],"end_ts":null,"status":"InProgress"}

It looks like the ID is not returned as part of the response. Do you want me to raise an issue for this?

2. I can look further into it, but after looking it does not seem possible in Home Assistant to subscribe to external websockets.

[mbecker20]

For 1, the update id is available on the response as "_id": { "$oid": "..." } and there is no situation where Komodo would not include it in the execute responses. It may not be printed by windows curl because the field starts with _. You can confirm this via piping the response with jq '.'.

[Getslow6]

I've tried it in multiple ways, but I can't get the _id to show in the responses 😞

On Windows with jq:

Piping it to a response.json file also without an id.

In Home assistant / Linux:

Linux:

[Getslow6]

Ok I found the bug; it has to do with the function:

• DeployStackIfChanged produces an output with "operation":"DeployStack" (you would expect "operation":"DeployStackIfChanged") and no _id field
• DeployStack produces an output with "operation":"DeployStack" and with _id field

[mbecker20]

Hm, you initially mentioned DeployStack as the api. Correct the IfChanged method will not return id, because at the time the function needs to return it does not know if an actual update needs to be created. You will notice there may not always be an update for this method.

[Getslow6]

You're right. Thanks for the help and excuse me for the confusion.