Update Integration
Updates the integration details such as bucket name, bucket region, name, compressData, and roleArn of the AWS S3 bucket with Qualys.
Where id is the IntegrationID provided by Qualys.
You can also regenerate the external ID using this API if needed. If you have regenerated 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 |
|---|---|---|---|
bucketName={value} |
Optional, if accessPointArn is provided. |
String | Provide the name of the AWS S3 bucket being used for integration. |
bucketRegion={value} |
Mandatory | String | Provide the region where the AWS S3 bucket is located. |
roleArn={value} |
Mandatory | String | Specify the ARN of the cross-account role which you created in your AWS account. |
accessPointArn = {value} |
Optional, if bucketName is provided. |
string |
Provide the Access Point ARN. Steps to obtain this value are documented in step 4 of the AWS S3 Configuration. When both bucketName and accessPointArn are set, the bucketName value is prioritized. |
integrationType={value} |
Mandatory | String | Specify the type of integration. Provide the value “aws_s3”. |
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/product-id/integration ""--data""@integration.json""-H""Authorization: Bearer <token>"
“integration.json” contains the request PUT data.
Request PUT Data (integration.json)
{
"integrationType": "aws_s3",
"bucketName": "pc-findings-rc",
"bucketRegion": "us-east-2",
"roleArn": "arn:aws:iam::xxxxxxxxxxx:role/pc-role-rc"
}
Output
{
"messsage": "Integration updated successfully."
}