GoodMemGoodMem
ReferenceAPIREST APISystem

Retrieve server build metadata

GET /v1/system/info: Returns the server's advertised semantic version, git metadata, build timestamp, and optional capability flags.

GET
/v1/system/info

Returns the server's advertised semantic version, git metadata, build timestamp, and optional capability flags. The endpoint is intentionally unauthenticated so bootstrap tooling can call it before API keys exist.

Header Parameters

GoodMem-Timeout-Ms?integer

Optional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.

Formatint64
Range1 <= value <= 86400000

Response Body

Server build metadata

application/json
  1. response
version*string

Semantic version string advertised by the running server.

major*integer

Major version component parsed from the advertised semantic version.

Formatint32
Range0 <= value
minor*integer

Minor version component parsed from the advertised semantic version.

Formatint32
Range0 <= value
patch*integer

Patch version component parsed from the advertised semantic version.

Formatint32
Range0 <= value
dirty*boolean

Whether the running build reports uncommitted workspace changes.

gitCommit?string

Git commit SHA baked into the build, when available.

gitDescribe?string

Git describe output baked into the build, when available.

buildTime?string

Build timestamp recorded for this server binary, when available.

Formatdate-time
capabilities?

Optional capability flags or metadata advertised by the running server.

Example Request
curl -X GET 'https://your-goodmem-server.example.com/v1/system/info' \  -H 'GoodMem-Timeout-Ms: 30000'
Example Response
{  "version": "string",  "major": 0,  "minor": 0,  "patch": 0,  "dirty": true,  "gitCommit": "string",  "gitDescribe": "string",  "buildTime": "2019-08-24T14:15:22Z",  "capabilities": {    "property1": "string",    "property2": "string"  }}