[Feature] make version available in some kind of api output #1100

Closed
opened 2025-12-29 02:28:16 +01:00 by adam · 4 comments
Owner

Originally created by @mstewart14 on GitHub (Sep 16, 2025).

Use case

An admin-side service or API that

  • provides version information about headscale so updates can be tracked and managed

Description

I run a bunch of docker containers including headscale. I track version number and updates using release-argus, it's a simple dashboard showing what containers have version numbers that don't match a source (like github or docker hub).
Most docker apps have an API or URL from which I can get the version number. For Headscale I haven't found that. This is a nice to have. If it creates problems it's not a big deal.
Thank you for making this software. It is awesome to be able to run my own VPN that's not too difficult to use.

Contribution

  • I can write the design doc for this feature
  • I can contribute this feature

How can it be implemented?

create a protected API service specifically to deliver version (and any other useful data someone might want to use ) for tracking and automation?

Originally created by @mstewart14 on GitHub (Sep 16, 2025). ### Use case An admin-side service or API that - provides version information about headscale so updates can be tracked and managed ### Description I run a bunch of docker containers including headscale. I track version number and updates using release-argus, it's a simple dashboard showing what containers have version numbers that don't match a source (like github or docker hub). Most docker apps have an API or URL from which I can get the version number. For Headscale I haven't found that. This is a nice to have. If it creates problems it's not a big deal. Thank you for making this software. It is awesome to be able to run my own VPN that's not too difficult to use. ### Contribution - [ ] I can write the design doc for this feature - [ ] I can contribute this feature ### How can it be implemented? create a protected API service specifically to deliver version (and any other useful data someone might want to use ) for tracking and automation?
adam added the enhancementstalehelp wantedgood first issue labels 2025-12-29 02:28:16 +01:00
adam closed this issue 2025-12-29 02:28:16 +01:00
Author
Owner

@github-actions[bot] commented on GitHub (Dec 17, 2025):

This issue is stale because it has been open for 90 days with no activity.

@github-actions[bot] commented on GitHub (Dec 17, 2025): This issue is stale because it has been open for 90 days with no activity.
Author
Owner

@TeejMcSteez commented on GitHub (Dec 17, 2025):

Doesn't a /version endpoint already exist? On my current v0.27.1 if I hit /version it will return version, commit, and build-time alongside Go version, Arch., and OS as JSON. I was going to try to work on this but I think it is already completed.

@TeejMcSteez commented on GitHub (Dec 17, 2025): Doesn't a /version endpoint already exist? On my current v0.27.1 if I hit /version it will return version, commit, and build-time alongside Go version, Arch., and OS as JSON. I was going to try to work on this but I think it is already completed.
Author
Owner

@mstewart14 commented on GitHub (Dec 18, 2025):

Thank you yes, it works exactly as I need it to. Is it documented anywhere? I can't find it in any of the documentation or on the swagger page.
Thank you for pointing this out.

@mstewart14 commented on GitHub (Dec 18, 2025): Thank you yes, it works exactly as I need it to. Is it documented anywhere? I can't find it in any of the documentation or on the swagger page. Thank you for pointing this out.
Author
Owner

@TeejMcSteez commented on GitHub (Dec 18, 2025):

Thank you yes, it works exactly as I need it to. Is it documented anywhere? I can't find it in any of the documentation or on the swagger page. Thank you for pointing this out.

No don't think it is documented anywhere the only reason I found it is I saw that the their was a handler for /version endpoint in the source code while doing some changes. Prob should be added to the swagger or at least docs might try to look into it and fix this on the swagger end but glad that helped!

@TeejMcSteez commented on GitHub (Dec 18, 2025): > Thank you yes, it works exactly as I need it to. Is it documented anywhere? I can't find it in any of the documentation or on the swagger page. Thank you for pointing this out. No don't think it is documented anywhere the only reason I found it is I saw that the their was a handler for `/version` endpoint in the source code while doing some changes. Prob should be added to the swagger or at least docs might try to look into it and fix this on the swagger end but glad that helped!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#1100