Register Integration
Registers an integration.
Input ParametersInput Parameters
|
Parameter |
Optional/ Manadatory |
Data Type |
Description |
|---|---|---|---|
|
bucketName={value} |
Mandatory | Integer |
Provide the name of the AWS S3 bucket being used for integration. |
|
bucketRegion={value} |
Mandatory | Integer |
Provide the region where the AWS S3 bucket is located. |
|
roleArn={value} |
Mandatory | Integer |
Specify the ARN of the cross-account role which you created in your AWS account. |
|
name={value} |
Mandatory | Integer |
Provide a unique name for the integration in the API request. The maximum length allowed for the name is 50 characters. |
|
minSeverity={value} |
Optional | Integer |
The minimum severity level of the vulnerabilities fetched from Qualys (VM/VMDR app) to be posted on the AWS S3 bucket. By default, it is configured to severity level 3 and above. For example, if you set the value to 1, all findings with severity level 1 to 5 are fetched and available on AWS S3 bucket. |
|
baseCategory={IG|Potential|Confirmed} |
Optional | string |
Category of the vulnerabilities fetched from Qualys (VM/VMDR app) to be posted on the AWS S3. The valid values are IG, Confirmed, and Potential.
|
|
resultSectionNeeded={true|false} |
Optional | Boolean |
Set this to true to include the result section in the finding. If you want to exclude the result section, set this parameter to false. By default, the resultSectionNeeded parameter is configured to false. |
|
sendVulnInfo={true|false} |
Optional | Boolean |
Set this to true if you need the vulnerability information. If you want to exclude the vulnerability information, set this parameter to false. By default, the sendVulnInfo parameter is configured to false. |
|
compressData={true|false} |
Optional | Boolean |
Set this to true to compress the data in the response. It saves on disk and network IO. If you want to exclude the compression, set this parameter to false. By default, the compressData parameter is configured to true. |
|
sendAlerts |
Optional | Boolean |
Set to true to receive ProActive alert notifications. |
|
errorEmails |
Optional | Boolean |
When sendAlerts is set to true, provide the email list for ProActive Alert notifications. Add upto aList of maximum 5 email addresses as comma-separated values. |
API Request
"curl -H ‘Authorization":"Bearer <token>’""Content-Type:application/json""<qualys_gateway_url>/partner-integration/aws/s3/vm""--data""@integration.json"
'integration.json' contains the request POST data.
Request POST Data (integration.json)
{
"bucketName":"qualys-vm-findings",
"bucketRegion":"us-east-1",
"minSeverity":4,
"baseCategory":"Potential",
"name":"Sample Name or Sample integration",
"resultSectionNeeded":true,
"sendVulnInfo":true,
"compressData":true,
"roleArn":"arn:aws:iam::xxxxxxxx:role/policy-role""sendAlerts":true,
" ""errorEmails":" "[
"<email address 1>",
" ""<email address 2>"
]
}
Output
{
"integrationId":5,
"externalId":"US_POD_1-1-xxxxxxxx-xxxx-xxxx-xxxxxx-xxxxxxxxxxxxx"
}