Skip to main content

getInstallationLinks

This method returns the installation links and full kits for an installation package.

Parameters

Parameter

Description

Included in request

Type

Values

companyId

The ID of the managed company.

If the parameter is not included in the request, the installation links available for all managed companies will be returned.

Optional

String

No additional requirements.

packageName

The name of the package.

If the parameter is not included in the request, all packages will be returned.

Optional

String

No additional requirements.

ringId

When included in the request, the metod will return the installation package associated with a specific staging ring.

Optional

Integer

No additional requirements.

Default value: 0

Possible values:

  • 0 - Slow ring

  • 3 - Production ring

  • 4 - Test 1 ring

  • 5 - Test 2 ring

Return value

This method returns an Array containing the list of installation links for the requested package, or for all available packages if none specified explicitly. There are two types of links:

  • Install link - These links download an executable file that initiates a download and installation process for the specified version of the security agent. It first downloads the full installation kit from the Bitdefender cloud servers and then starts the installation.

  • Full kit - these links download the full installation kit for the specified version of the security agent.

Installation method

FIle size

Windows compatibility

Linux compatibility

Mac compatibility

Install link

Small

32-bit, 64-bit, ARM

32-bit, 64-bit

64-bit

Full kit

Large

32-bit, 64-bit, ARM

32-bit, 64-bit, ARM

64-bit, ARM

Each entry in the list has the following fields:

Attribute

Type

Description

packageName

String

The name of the package for which you need the installation links and kits.

companyName

String

The name of the company to which the package belongs.

companyId

String

The ID of the above-mentioned company.

installLinkWindows

String

The link for the Windows downloader.

installLinkMac

String

The link for the Mac downloader.

installLinkMacArm

String

The link for the Mac (ARM) downloader.

installLinkLinux

String

The link for the Linux downloader.

fullKitWindowsX32

String

The link for the full installation kit for Windows 32-bit operating systems.

fullKitWindowsX64

String

The link for the full installation kit for Windows 64-bit operating systems.

fullKitWindowsArm64

String

The link for the full installation kit for Windows ARM 64-bit operating systems.

fullKitLinuxX32

String

The link for the full installation kit for Linux 32-bit operating systems.

fullKitLinuxX64

String

The link for the full installation kit for Linux 64-bit operating systems.

fullKitLinuxArm64

String

The link for the full installation kit for Linux ARM 64-bit operating systems.

installLinkMacDownloader

String

The link for the full installation kit for Mac operating systems.

installLinkMacArm

String

The link for the full installation kit for Mac ARM operating systems.

Examples

Request

Get the installation links for a specific installation package:

  {
     "params": {
       "companyId": "54a1a1d3b1a43d2b347b23c1",
       "packageName": "my package"
   },
     "jsonrpc": "2.0",
     "method": "getInstallationLinks",
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18"
  }

Get the installation links for the package associated to a specific staging ring:

{
	"method": "getInstallationLinks",
	"id": "736b0b48-63be-4b53-818e-b37df9b02e90",
	"jsonrpc": "2.0",
	"params": {
        "ringId":3
	}
}

Response

 {
     "id": "426db9bb-e92a-4824-a21b-bba6b62d0a18",
     "jsonrpc": "2.0",
     "result": [{
         "packageName":"PackagesAPI1695391314.2838118LYi87FksSq",
         "companyName": "TestC2",,
         "companyId": "54a1a1d3b1a43d2b347b23c1",
         "installLinkWindows":"https://10.18.150.205/Packages/BSTWIN/0/setupdownloader_[aHR0cHM6Ly9tYWMtMDAtNTAtNTYtOTYtMWYtZTEua2N1bGRhci5jb206ODQ0My9QYWNrYWdlcy9CU1RXSU4vMC8ybmxFNngvaW5zdGFsbGVyLnhtbD9sYW5nPWVuLVVT].exe",
         "installLinkMac":"https://10.18.150.205/Packages/MAC/0/2nlE6x/Bitdefender_for_MAC.dmg",
         "installLinkMacArm":"https://10.18.150.205/Packages/MAC/0/2nlE6x/Bitdefender_for_MAC_ARM.dmg",
         "installLinkMacDownloader":"https://10.18.150.205/Packages/MAC/0/2nlE6x/setup_downloader.dmg",
         "installLinkLinux":"https://10.18.150.205/Packages/NIX/0/2nlE6x/setup_downloader.tar",
         "fullKitWindowsX32":"https://10.18.150.205/api/v1.0/http/downloadPackageFullKit?packageId=650d9e53ac5599df31045d7f&downloadType=19",
         "fullKitWindowsX64":"https://10.18.150.205/api/v1.0/http/downloadPackageFullKit?packageId=650d9e53ac5599df31045d7f&downloadType=20",
         "fullKitWindowsArm64":"https://10.18.150.205/api/v1.0/http/downloadPackageFullKit?packageId=650d9e53ac5599df31045d7f&downloadType=35",
         "fullKitLinuxX32":"https://10.18.150.205/api/v1.0/http/downloadPackageFullKit?packageId=650d9e53ac5599df31045d7f&downloadType=21",
         "fullKitLinuxX64":"https://10.18.150.205/api/v1.0/http/downloadPackageFullKit?packageId=650d9e53ac5599df31045d7f&downloadType=22",
         "fullKitLinuxArm64":"https://10.18.150.205/api/v1.0/http/downloadPackageFullKit?packageId=650d9e53ac5599df31045d7f&downloadType=36",
         "companyName":"PackagesAPI1695391310.4621398PR2EsksWlt",
         "companyId":"650d9e4f2cd3e936350495b7"
      }]
  }  

    {
	"id": "736b0b48-63be-4b53-818e-b37df9b02e90",
	"jsonrpc": "2.0",
	"result": [
		{
			"packageName": "test",
			"installLinkWindows": "$installLinkWindowsByRingId",
			"installLinkMac": "https:\/\/cloud.hydra.docker\/Packages\/MAC\/0\/wtnruh\/Bitdefender_for_MAC.dmg",
			"installLinkMacArm": "https:\/\/cloud.hydra.docker\/Packages\/MAC\/0\/wtnruh\/Bitdefender_for_MAC_ARM.dmg",
			"installLinkMacDownloader":”$installLinkMacDownloaderByRingId",
			"installLinkLinux": “$installLinkLinuxByRingId",
			"fullKitWindowsX32": "https:\/\/cloud.hydra.docker\/api\/v1.0\/http\/downloadPackageFullKit?packageId=666af2f18f7363fb6508cb42&downloadType=19",
			"fullKitWindowsX64": "https:\/\/cloud.hydra.docker\/api\/v1.0\/http\/downloadPackageFullKit?packageId=666af2f18f7363fb6508cb42&downloadType=20",
			"fullKitWindowsArm64": "https:\/\/cloud.hydra.docker\/api\/v1.0\/http\/downloadPackageFullKit?packageId=666af2f18f7363fb6508cb42&downloadType=35",
			"fullKitLinuxX32": "https:\/\/cloud.hydra.docker\/api\/v1.0\/http\/downloadPackageFullKit?packageId=666af2f18f7363fb6508cb42&downloadType=21",
			"fullKitLinuxX64": "https:\/\/cloud.hydra.docker\/api\/v1.0\/http\/downloadPackageFullKit?packageId=666af2f18f7363fb6508cb42&downloadType=22",
			"fullKitLinuxArm64": "https:\/\/cloud.hydra.docker\/api\/v1.0\/http\/downloadPackageFullKit?packageId=666af2f18f7363fb6508cb42&downloadType=36",
			"companyName": "Bitdefender",
			"companyId": "666ae9af01bfab9b4f05ed85"
		}
	]
}

Note

<gz_ip> is the IP address of GravityZone Control Centerthe management console.

You can use one of the provided URL addresses to download the installation package:

  • If you are using a GZVA Self-Signed certificate.

    curl -fOJ -H "YOUR_API_KEY:" https://gravityzone.bitdefender.com/api/v1.0/http/downloadPackageFullKit?packageId=5645cba6f12a9a8c5e8b4748&downloadType=20

  • If you are not using a GZVA Self-Signed certificate.

    curl -fOJ -H "Authorization: Basic ENCODED_API_KEY" https://gravityzone.bitdefender.com/api/v1.0/http/downloadPackageFullKit?packageId=5f1ecde1be4be6142c3e9b32&downloadType=20

Note

API_KEY_ENCODED_BASE64 is your API key encoded using base64.

To get your ENCODED_API_KEY, use the following entry:

echo "YOUR_API_KEY:" | base64
In this section: