Download Agent Binaries

[POST] /qps/rest/1.0/download/ca/downloadbinary

Download the agent installer binaries using API.

Permissions required - Managers with full scope. Other users must have these permissions: Access Permission “API Access” and Asset Management Permission “Read Asset”.

Input ParametersInput Parameters

Use these parameters to download an installer binary. Depending on the availability for your platform, you will be able to download a particular installer.

Parameter

Mandatory

/Optional

Data Type

Description

platform

Mandatory

value

Specify platform type. Valid values are WINDOWS, MACOSX, MACOSX_M_1, LINUX, AIX, LINUX_UBUNTU, LINUX_PPC_64_LE, BSD, SOLARIS_X_86, SOLARIS_SPARC, LINUX_COREOS, LINUX_S_390_X, LINUX_UBUNTU_S_390_X, GENTOO_LINUX, and LINUX_AWSBR.

Platform value is case sensitive.

architecture

Mandatory value

Specify platform architecture. Valid values are X_86_64, ARM_64, X_64, POWER_5, SPARC, PPC_64_LE, and S_390_X

Architecture value is case sensitive.

 

For fetching agent installer binary version for Cloud Agent Linux on zSystems, two-level check is performed—at the platform level and at the subscription level. . Only when the agent is available for the platform and your subscription, you can download the agent binary.

For more information on supported platform and architecture, refer to the Cloud Agent Platform Availability Matrix section from Cloud Agent Getting Started Guide.

This document provides sample requests and responses to download agent binaries using Curl. You can also use our Postman Collections to download agent binaries.

Sample - Download Windows X86_64 installer binarySample - Download Windows X86_64 installer binary

API request

curl -u fo_username:password -X POST -H "Content-Type: text/xml" -H "X-Requested-With: curl" --data-binary @download_binary.xml "<qualys_base_url>/qps/rest/1.0/download/ca/downloadbinary/" --remote-name --remote-header-name
        
    

 

 

Request POST data

<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
    <data>
        <DownloadBinary>
            <platform>WINDOWS</platform>
            <architecture>X_86_64</architecture>
        </DownloadBinary>
    </data>
</ServiceRequest>      
    

Response (Success)

Installer binary will be downloaded with Status: 200 OK      
    

Response (Fail)

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/portal-api/xsd/1.0/ca/downloadbinary.xsd">
    <responseCode>OTHER_ERROR</responseCode>
    <responseErrorDetails>
        <errorMessage>An error occurred during request processing. Please contact your account manager.</errorMessage>
    </responseErrorDetails>
</ServiceResponse>