Skip to content
ssoossh

Get server version

GET
/api/version
curl --request GET \
  --url https://example.com/api/version

Unauthenticated endpoint that returns the running server’s build identity for display in the web UI footer. What it reveals is governed by version.mode: “show” (the real build), “hide” (nothing), or “fake” (a fixed string). Values come from the build stamp; an untagged build reports “development” and omits the release URL.

Responses

Section titled “Responses”

200

Section titled “200”

Build identity of the running server

Media typeapplication/json
object
data
required
object
commit
required

Commit is the git revision the build came from. It is what identifies a “development” build, which has no release of its own to point at.

string
github_url
required

GithubURL is the project’s source repository. Served rather than hardcoded in the frontend so that a fork only has to change internal/version.

string
release_url

ReleaseURL points at the GitHub release matching Version. Omitted for an untagged build, where there is no release page to link to.

string
version
required

Version is the release this binary was built from, without the tag’s leading “v” (goreleaser and the Makefile both strip it). Untagged builds report the “development” default from internal/version.

string
error
string

Example generated

{
  "data": {
    "commit": "example",
    "github_url": "example",
    "release_url": "example",
    "version": "example"
  },
  "error": "example"
}