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 artifact base URL.

Response Properties:

  • versionTag (String): The version tag of the bundled agent.
  • linuxScriptUrl (String): URL to download the Linux installation script (install.sh).
  • windowsScriptUrl (String): URL to download the Windows installation script (install.ps1).
  • artifactBaseUrl (String, Optional): The base URL where agent artifacts are hosted, if configured.

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).