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

New Issue

OVERLORD · 2026-02-05T09:53:40+03:00

OVERLORD commented

2026-02-05 09:53:40 +03:00

Originally created by @nosebeggar on GitHub (May 5, 2025).

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

Originally created by @nosebeggar on GitHub (May 5, 2025). ### 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_

OVERLORD added the 🔩 API Request label 2026-02-05 09:53:40 +03:00

OVERLORD closed this issue

2026-02-05 09:53:42 +03:00

OVERLORD commented

2026-02-05 09:53:45 +03:00

@ssddanbrown commented on GitHub (May 5, 2025):

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.

@ssddanbrown commented on GitHub (May 5, 2025): 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.

OVERLORD commented

2026-02-05 09:53:47 +03:00

@nosebeggar commented on GitHub (May 5, 2025):

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!

@nosebeggar commented on GitHub (May 5, 2025): 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!

OVERLORD commented

2026-02-05 09:53:49 +03:00

@ssddanbrown commented on GitHub (May 5, 2025):

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 commented on GitHub (May 5, 2025): 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

OVERLORD commented

2026-02-05 09:53:51 +03:00

@ssddanbrown commented on GitHub (May 22, 2025):

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

@ssddanbrown commented on GitHub (May 22, 2025): This has been added via #5607, ready to be part of the next feature release. Thanks again @nosebeggar for the request.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#5277