Distribution Commands

• getDistributionStatus
• getDistributionURL
• getDistributionVersions
• createDistribution
• deleteDistribution

getDistributionStatus

---

Retrieves the creation status of one or more agent installers (distributions), such as in progress, completed, or failed.

Arguments

Argument Name	Description	Required
distribution_ids	A comma-separated list of distribution IDs.	Required

Outputs

Core.Distribution.id string

The distribution ID.

Core.Distribution.status string

The status of the distribution.

getDistributionURL

---

Downloads an agent installer (distribution) package and returns it as a file entry in the War Room. Use the getDistributionStatus command to verify that the distribution creation process has been completed and is ready for download.

Arguments

Argument Name	Description	Required
distribution_id	The ID of the distribution.	Required
package_type	The package type to download. Possible values are: upgrade, sh, rpm, deb, pkg, x86, x64.	Required

Outputs

There are no outputs for this command.

getDistributionVersions

---

Retrieves the list of agent versions available per operating system for creating a new agent installer (distribution).

Arguments

There are no input arguments for this command.

Outputs

Core.DistributionVersions.windows string

Available Windows agent versions.

Core.DistributionVersions.linux string

Available Linux agent versions.

Core.DistributionVersions.macos string

Available macOS agent versions.

createDistribution

---

Creates an agent installer (also known as a distribution) used to deploy or upgrade the agent on endpoints, and polls until creation completes. The returned distribution ID can be used with getDistributionURL to download the installer.

Note: This is a polling command.

Arguments

Argument Name	Description	Required
name	Name of the installation package.	Required
platform	Platform for the installation package. Possible values are: windows, linux, macos, android.	Required
package_type	Type of installation package. Possible values are: standalone, upgrade.	Required
agent_version	Agent version. Required for every platform except android.	Optional
description	Free-text description of the distribution.	Optional
interval_in_seconds	Interval in seconds between each poll. Default is 20 seconds.	Optional
timeout_in_seconds	Polling timeout in seconds. Default is 300 seconds.	Optional

Outputs

Core.Distribution.id string

The ID of the created distribution.

Core.Distribution.name string

The name of the distribution.

Core.Distribution.platform string

The platform for which the distribution was created.

Core.Distribution.package_type string

The package type of the distribution.

Core.Distribution.agent_version string

The agent version baked into the distribution.

Core.Distribution.description string

The description of the distribution.

deleteDistribution

---

Deletes an agent installer (also known as a distribution). This does not affect endpoints where the agent has already been installed.

Arguments

Argument Name	Description	Required
distribution_id	The ID of the distribution to delete.	Required

Outputs

There are no outputs for this command.