Controlling backup jobs from Home Assistant?

[mattbue]

Hi,
first: thanks for developing this integration.
Could it be possible to control backups that are configured within "Sync & Backup" from the Home Assistant integration?
That would help me a lot.

Thanks

[Tom-Bom-badil]

Not sure - I'll have a look into it. Usually for this kind of request it's necessary to track down the so-called 'endpoint' of the API to query or to send commands to. For the time being, I am not aware of this particular one (that I didn't come across it yet doesn't mean it isn't there).

/tom

[mattbue]

Ok, thanks!
Do you have access to a documentation of API? So far I couldn't find any information concerning an API.

[Tom-Bom-badil]

No - AFAIK there is no public documentation for the API. All I have is what is written on the project's Wiki, and what I came across with trial & error.

/tim

[Tom-Bom-badil]

Haven't found a way yet to actually 'control' it - but seems it's possible to pull the log files. I can then format it to something useful after pulling it, so it's addressable by HA automations (e.g. warning 'Backup last night did not succeed!'). Would that be ok for you at the beginning, or are you explicitely looking for something to 'trigger' and really control the backup?

Browser with your NAS'es http port::
http://nas_ip:nas_port/ugreen/v1/web/sync/log/operation/search?token=your_token
how to obtain your_token
where to convert the timestamps shown

/tom

[mattbue]

Hi, for the beginning this is great.
Being able to start a specific backup job would be very usefull.
Thanks!

[Tom-Bom-badil]

Hi Matt @mattbue, quick status update / what I found out so far:

• There are several endpoints related to backups. It can be split into two main categories:
  
  
  • Backup reporting / log: Those are 'regular' v1 API endpoints, as all the other UGOS endpoints the integration is already using. Easy to query. Example: List the recent backups with status:
    http://nas_ip:nas_port/ugreen/v1/web/sync/log/operation/search?token=your_token
    
    
  • Backup definition / tasks overview / trigger actions: These v2 endpoints seem to be defined within the Backup App itself, and are not using the regular 'plain' query format of the UGOS API. Instead, the queries contain an encrypted part, and so far I have no idea on how to deal with that (the entire API still remains undocumented to the public). Example: List all backup tasks that are defined:
    http://nas_ip:nas_port/ugreen/v2/web/syncbackup/task/list?token=your_token

I will keep searching a solution for this, but some assistance here would be appreciated, as my spare time to do this is currently quite limited.

/tom