add backup api; closes #865

[fabianfrz]

@fichtner as I told you less than 10 lines of code (7)

[AdSchellevis]

easy as that indeed, it would be good to add some simple template with a download button (+menu registration) which triggers this, so people know where to look after installation.

[mimugmail]

Isnt this something for core :)

[AdSchellevis]

@mimugmail opnsense/core#2731

[fabianfrz]

@AdSchellevis I don't think we should duplicate core features as you already mentioned in the ticket before. This is just for automation.

[fichtner]

I'd prefer this to be API-only, point to the docs in the description and maybe add an XML push as well for symmetry?

[fabianfrz]

@fichtner the ticket said read-only API…

Push is IMHO not so easy (XML validation) and may have other issues (new machine ist not yet set up).

[fichtner]

ok, fine. :)

[fichtner]

ps, I'd prefer "api-backup" in naming

please wait for @AdSchellevis to ack or to incorporate his feedback

[AdSchellevis]

@fichtner ack, using api-backup as endpoint name, better to remove the ui/* acl as well then.

[fabianfrz]

@fichtner @AdSchellevis api-backup would move it at the top of the list of available plugins and may lead to a group of api- plugins.

If you are talking about the namespace or endpont: they cannot contain dashes.

[fichtner]

just the name, we do the same for "theme-"

[fabianfrz]

ok, no problem

[fichtner]

We could ultimately work on firmware GUI showing "theme-" and "api-" in different blocks if you worry about ordering :)

[fabianfrz]

@fichtner wait for it when it is needed

[fabianfrz]

@fichtner merge now?

[fichtner]

yes 👍

[Clement-Ruiz]

Hello there.

Nice job you've done here.
Could you add this feature to documentation please ? the usage might be kind of an evidence for you guys, but I'm not a OpnSense contributor, and even looking at source code I can't figure out which url I must request in order to get my backup.
Mabe somewhere like here ? https://wiki.opnsense.org/development/api.html#plugins-api

Thank you

[mimugmail]

@Clement-Ruiz How about this, you clone the docs repo and write it to contribute to all other? :)

This is the API call:

curl -k -u "key":"secret" https://192.168.0.1/api/backup/backup/download

[Clement-Ruiz]

Hello @mimugmail, thanks for your response.
Expect your PR. ;)
Have a great one

[mimugmail]

Thx 👍