Update Integration
Updates the integration details such as bucket name, bucket region, minSeverity, baseCategory, name, resultSectionNeeded, sendVulnInfo, compressData, and roleArn of the AWS S3 bucket with Qualys.
You can also regenerate the externalID using this API if needed. If you regenerate the externalID using this API, you must re edit the trust relationship. For more information, see Appendix: Editing Trust Relationship after Regenerating External ID.
Input ParametersInput Parameters
|
Parameter |
Optional /Mandatory |
Data Type |
Description |
|---|---|---|---|
|
id |
Optional | Integer |
It is IntegrationID provided by Qualys. |
|
bucketName={value} |
Optional | Text |
Provide the name of the AWS S3 bucket being used for integration. |
|
bucketRegion={value} |
Optional | Text |
Provide the region where the AWS S3 bucket is located. |
|
roleArn={value} |
Mandatory | Text |
Specify the ARN of the cross-account role that you created in your AWS account. |
|
name={value} |
Mandatory | Text |
Provide a unique name for the integration in the API request. The maximum length allowed for the name is 50 characters. |
|
minSeverity={value} |
Optional | Text |
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 | Text |
Category of the vulnerabilities fetched from Qualys (VM/VMDR app) to be posted on the AWS S3. Thevalid 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. Set this parameter to false if you want to exclude the vulnerability information. 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 be true. |
|
regenerateExternalId |
Optional | Boolean |
Set this to true if you want to regenerate the external ID. The default value is set to false. |
|
sendAlerts |
Optional | Boolean |
Set to true to receive ProActive alert notifications. |
|
errorEmails |
Optional | Text |
When sendAlerts is set to true, provide the email list for ProActive Alert notifications. Add up to list of maximum of 5 email addresses as comma-separated values. |
This example is for updating the configuration details of the AWS S3 bucket integration by providing the integration ID in the request.
API Request
"curl -X PUT
--header""Content-Type:application/json""<qualys_gateway_url>/partner-integration/aws/s3/{id}/vm""--data""@integration.json""-H""Authorization: Bearer <token>"
'integration.json' contains the request PUT data.
Request PUT Data (integration.json)
{
"bucketName":"qualys-vm-findings",
"bucketRegion":"us-east-1",
"minSeverity":2,
"baseCategory":"Confirmed",
"name":"Customer Name or integration name",
"resultSectionNeeded":true,
"sendVulnInfo":true,
"compressData":true,
"roleArn":"arn:aws:iam::xxxxxxxxx:role/policy-role",
"regenerateExternalId":false"sendAlerts":true,
" ""errorEmails":" "[
"<email address 1>",
" ""<email address 2>"
]
}
Output
{
"messsage":"AWS S3 VM integration successfully updated."
}
This sample is for updating the configuration details of the AWS S3 bucket integration by setting regenerateExternalId to true.
API Request
"curl -X PUT
--header""Content-Type:application/json""<qualys_gateway_url>/partner-integration/aws/s3/{id}/vm""--data""@integration.json""-H""Authorization: Bearer <token>"
'integration.json' contains the request PUT data.
Request PUT Data (integration.json)
{
"bucketName":"qualys-vm-findings",
"bucketRegion":"us-east-1",
"minSeverity":2,
"baseCategory":"Confirmed",
"name":"Customer Name or integration name",
"resultSectionNeeded":true,
"sendVulnInfo":true,
"compressData":true,
"roleArn":"arn:aws:iam::xxxxxxxx:role/policy-role",
"regenerateExternalId":true
}
Output
{
"message":"AWS S3 VM Integration successfully updated.",
"externalId":"US_POD_1-1- xxxxxxxx-xxxx-xxxx-xxxxxx-xxxxxxxxxxxxx"
}