Skip to content

API: Add system endpoint to provide app version number amoung other details #5603

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
nosebeggar opened this issue May 5, 2025 · 4 comments
Closed

Comments

@nosebeggar
Copy link

API Endpoint or Feature

Hi, in the API documentation I could not find an endpoint that will provide me with the version number of my installed instance. Am I stupid or does BS really not provide one so far?

Use-Case

I'm writing icinga checks for all my services to compare them to the newest available version on github.

Additional context

No response

@ssddanbrown
Copy link
Member

Hi @nosebeggar,
No current official endpoint provided for this.

There was a previous request in #3343.
If desired, I could re-purpose this issue to focus on adding a /system api endpoint as described in that thread, to provide the current version number among other details.

@nosebeggar
Copy link
Author

Hi,
that would be fabulous. I mean, I like a good, dirty solution, but i don't see any reason to not add this to the regular API. Every other service I'm using has one such key, would be nice to have this in bookstack. Thanks a lot!

@ssddanbrown ssddanbrown changed the title Getting the version number via API? API: Add system endpoint to provide app version number amoung other details May 5, 2025
@ssddanbrown ssddanbrown added this to the Next Feature Release milestone May 5, 2025
@ssddanbrown
Copy link
Member

Okay, I've updated the title and set the target for next feature release as it should be a simple thing to add.

We'll start with the below details, with potential to expand based on needs in the future.

  • Configured App name
  • App version string
  • App ID (Added via settings in recent release for ZIP exports).
  • App logo reference

@ssddanbrown
Copy link
Member

This has been added via #5607, ready to be part of the next feature release.
Thanks again @nosebeggar for the request.

# for free to join this conversation on GitHub. Already have an account? # to comment
Development

No branches or pull requests

2 participants