Skip to content

server

The server domain has 3 actions. On the meta surface they are all reached through arcane_server; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

ActionTitleKind
server.app_versionGet app versionread
server.healthHealth checkread
server.versionGet version informationread

Get app version

Get the current application version

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_server with "action": "app_version"
  • Individual tool: arcane_server_app_version
  • Arcane route: GET /api/app-version
  • Operation ID: getAppVersion
  • Usage: Full version and build details of the manager, no credentials or parameters: currentVersion, displayVersion, revision, goVersion, buildTime, enabledFeatures, and the running image’s currentTag/currentDigest when Arcane runs in a container. Its update fields (updateAvailable, newestVersion, newestDigest, releaseUrl, releaseNotes, releasedAt) also cover digest-tracking builds (next channel or a non-release tag such as latest), where updateAvailable comes from the image digest and newestVersion may be absent. For a manager started from a digest-pinned image (name@sha256:…) they come from a live registry lookup of the image’s tag (latest when the reference names none), never from Arcane’s stored image-update record. server.version does not do this, and all update fields stay empty when update checks are disabled. For an agent or remote environment’s version use environment.version (environmentId from environment.list), which returns the same fields.
  • Related actions: server.version, environment.version, system.upgrade_check

Health check

Check if the API is healthy

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_server with "action": "health"
  • Individual tool: arcane_server_health
  • Arcane route: GET /api/health
  • Operation ID: health-check
  • Usage: Liveness check of the Arcane manager itself. It needs no credentials and takes no parameters. Returns status UP, or DOWN with HTTP 503 once the server’s internal runtime has stopped, so it tells an unreachable or failing server from a credentials problem. It says nothing about remote environments: check those with environment.test or environment.version.
  • Related actions: server.version, server.app_version, environment.test

Get version information

Get application version information and check for updates

  • Kind: read
  • Required parameters: none
  • Meta tool: arcane_server with "action": "version"
  • Individual tool: arcane_server_version
  • Arcane route: GET /api/version
  • Operation ID: getVersion
  • Usage: Lightweight check of the manager’s version against the latest GitHub release. It needs no credentials. Returns currentVersion (v-prefixed when it is numeric), updateAvailable, and newestVersion plus a matching releaseUrl when the release lookup succeeded and the latest release is not older than currentVersion. If update checks are disabled or GitHub is unreachable it still answers, with updateAvailable false and no newestVersion, so a missing newestVersion means unknown, not up to date. Optional current compares that version instead of the running one. For build details, release notes or digest-based updates of non-release tags use server.app_version.
  • Related actions: server.app_version, environment.version, system.upgrade_check, system.upgrade