Skip to content

Server Info

The server info endpoint returns version and identity information about a running Canvus Server instance. Use it to verify connectivity, confirm which server version is deployed, or check API compatibility before making further requests.

This endpoint requires no authentication and is a good first call to confirm your Canvus Server is reachable.

Get Server Info

Returns the server's version string, unique identifier, supported API versions, and the Go runtime version used by the HTTP frontend.

Request

  • Method: GET
  • URL: /api/v1/server-info
  • Authentication: None required
  • Streaming: Not supported

Response Fields

  • server_id -- UUID that uniquely identifies this server instance. Persists across restarts.
  • version -- Server version string including the build hash in brackets (e.g., "3.4.12 [a1b2c3d4e]").
  • api -- Array of supported API version strings. Currently ["v1.3"].
  • go -- Version of the Go runtime powering the HTTP frontend.

Example Request

curl https://canvus.example.com/api/v1/server-info

Example Response

{
  "api": [
    "v1.3"
  ],
  "go": "1.22.5",
  "server_id": "b7e4d930-8f12-4a6c-9e3b-2d5f1c8a7b09",
  "version": "3.4.12 [a1b2c3d4e]"
}

Error Responses

  • 500 Internal Server Error -- The server is running but encountered an internal error. Response body: {"msg": "error description"}.

If the request fails to connect at all, the server is not running or not reachable at the given hostname.