Skip to content

Build metadata.

GET
/version
Code sample: Shell / cURL
curl --request GET \
--url https://stratum.example.com/version

OK

Media typeapplication/json
object
version
required
string
commit
required
string
buildDate
required
string format: date-time
release

The release this control plane’s node runs, the release identity of the install (the same as runningRelease of the node in GET /v1/admin/upgrades/release). version stays this binary’s own build, which is a development build when the release pins a control plane published before the release was tagged. Absent when the node does not know its release.

string
agentVersion

The in-VM instance-agent build this control plane serves over IMDS — what an instance’s own agentVersion should be compared against to tell a stale agent from a current one. Absent when no agent build is published.

string
clusterId

The cluster this control plane belongs to. The same id labels every metric series the cluster emits, so it is the key that partitions all of its observability data. Absent on an install that has no cluster id yet, which is distinct from one that is set-but-blank.

string
schemaLevel

The newest database migration this control plane carries. Absent before its migrations have run.

integer
schemaReadableBy

The oldest schema level whose control plane still runs against the schema this one produces. A rollback to a release below this level needs a restore of the pre-upgrade backup.

integer
databaseSchemaLevel

The database’s schema level. Above schemaLevel when this control plane runs against a newer schema that is still compatible with it.

integer

Example

{
"release": "0.2.0",
"clusterId": "cl-5byupirp",
"schemaLevel": 301,
"schemaReadableBy": 301,
"databaseSchemaLevel": 301
}