Skip to main content

Deployments API

The Deployments API provides endpoints for retrieving metadata and download URLs for Lumetry deployable components such as the Host Agent and Collector.

Get Agent Installer Metadata​

GET /api/deployments/agent-installer

Returns metadata required for installing the bundled host agent, including URLs for the installation scripts and deployment-local artifact URLs when configured.

Response Properties:

  • versionTag (String): The version tag of the bundled agent.
  • linuxScriptUrl (String, Optional): URL to download install.sh; null when no Linux package is staged.
  • windowsScriptUrl (String, Optional): URL to download install.ps1; null when no Windows package is staged.
  • artifactBaseUrl (String, Optional): The agent package directory used by the bootstrap, typically {artifactRootUrl}/agent/{versionTag}.
  • artifactRootUrl (String, Optional): The common deployment artifact root, for example https://host/artifacts.
  • collectorArtifactBaseUrl (String, Optional): The matching collector package directory, typically {artifactRootUrl}/collector/{versionTag}.
  • collectorLinuxScriptUrl (String, Optional): Authoritative Linux collector bootstrap URL; null when Linux is not staged.
  • collectorWindowsScriptUrl (String, Optional): Authoritative Windows collector bootstrap URL; null when Windows is not staged.
  • agentPlatforms (String Array): Exact staged agent targets: linux-x64, linux-arm64, and/or windows-x64.
  • collectorPlatforms (String Array): Exact staged collector targets from the same target set.

The product UI offers only operating-system families backed by these platform lists and script URLs. It never constructs a collector script URL or falls back to a container command. When no collector target is available, create-and-install is disabled until artifacts are staged. Pending-token regeneration and collector replacement are disabled for the same reason, preventing an operator from invalidating a usable registration without a corresponding install path. Bootstrap scripts verify packages against the published checksum manifest and retry the complete package-plus-manifest download up to three times if a mutable latest release changes between requests.

List Component Versions​

GET /api/deployments/component-versions

Returns a list of available versions and download URLs for a specific component type.

Note: This endpoint is not available in isolated (air-gapped) deployments, as component versions are sourced from Lumetry Mission Control.

Query Parameters:

  • componentType (String): The type of component. Must be either agent or collector.

Response Properties: An array of version objects containing:

  • componentType (String): The type of the component.
  • versionTag (String): The release version tag (e.g., v1.2.0).
  • releaseDate (DateTime): The date the version was released.
  • releaseNotes (String, Optional): Release notes or a link to release notes.
  • downloadUrls (Object): An object containing direct download URLs for supported architectures (linuxAmd64, linuxArm64, windowsAmd64, darwinAmd64, darwinArm64).