getInstallationLinks
This method returns the installation links and full kits for an installation package.
Warning
Make sure you have the right access permissions and the installation package is published in the Configuration > Update > Components page of Control Center. Otherwise, you may receive error 400 Bad request or 404 Not found.
Parameters
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| 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. |
| The name of the package. If the parameter is not included in the request, all packages will be returned. | Optional | String | No additional requirements. |
| 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: Possible values:
|
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 |
|---|---|---|
| String | The name of the package for which you need the installation links and kits. |
| String | The link for the Windows downloader. |
| String | The link for the Mac downloader. |
| String | The link for the Mac (ARM) downloader. |
| String | The link for the Linux downloader. |
| String | The link for the full installation kit for Windows 32-bit operating systems. |
| String | The link for the full installation kit for Windows 64-bit operating systems. |
| String | The link for the full installation kit for Windows ARM 64-bit operating systems. |
| String | The link for the full installation kit for Linux 32-bit operating systems. |
| String | The link for the full installation kit for Linux 64-bit operating systems. |
| String | The link for the full installation kit for Linux ARM 64-bit operating systems. |
| String | The link for the full installation kit for Mac operating systems. |
| String | The link for the full installation kit for MAC ARM 64-bit operating systems. |
| Object | An Object containing the supported operating systems and showing kits availability within your GravityZone environment for the following operating systems:
Possible status values:
|
Examples
Request
Get the installation links for a specific installation package:
{
"params": {
"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
{
"packageName":"PackagesAPI1695306052.633011oWYMHbCBM1",
"installLinkWindows":"https://10.18.148.224/Packages/BSTWIN/0/setupdownloader_[aHR0cHM6Ly8xMC4xOC4xNDguMjI0Ojg0NDMvUGFja2FnZXMvQlNUV0lOLzAvaUpuSF9fL2luc3RhbGxlci54bWw-bGFuZz1lbi1VUw==].exe",
"installLinkMac":"https://10.18.148.224/Packages/MAC/0/iJnH__/Bitdefender_for_MAC.dmg",
"installLinkMacArm":"https://10.18.148.224/Packages/MAC/0/iJnH__/Bitdefender_for_MAC_ARM.dmg",
"installLinkMacDownloader":"https://10.18.148.224/Packages/MAC/0/iJnH__/setup_downloader.dmg",
"installLinkLinux":"https://10.18.148.224/Packages/NIX/0/iJnH__/setup_downloader.tar",
"fullKitWindowsX32":"https://10.18.148.224/api/v1.0/http/downloadPackageFullKit?packageId=650c5145a024a1001303b99d&downloadType=19",
"fullKitWindowsX64":"https://10.18.148.224/api/v1.0/http/downloadPackageFullKit?packageId=650c5145a024a1001303b99d&downloadType=20",
"fullKitWindowsArm64":"https://10.18.148.224/api/v1.0/http/downloadPackageFullKit?packageId=650c5145a024a1001303b99d&downloadType=35",
"fullKitLinuxX32":"https://10.18.148.224/api/v1.0/http/downloadPackageFullKit?packageId=650c5145a024a1001303b99d&downloadType=21",
"fullKitLinuxX64":"https://10.18.148.224/api/v1.0/http/downloadPackageFullKit?packageId=650c5145a024a1001303b99d&downloadType=22",
"fullKitLinuxArm64":"https://10.18.148.224/api/v1.0/http/downloadPackageFullKit?packageId=650c5145a024a1001303b99d&downloadType=36",
"status":{
"windows":2,
"windowsArm64":0,
"linux":0,
"mac":0,
"macArm":0,
"macDownloader":0
}
}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