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 | 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. |
|
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 | Integer |
Set this to true if you want to regenerate the external ID. The default value is set to false. |
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_base_url>/partner-integration/aws/s3/{id}/pc""--data""@integration.json""-H""Authorization: Bearer <token>"
'integration.json' contains the request PUT data.
Request PUT Data (integration.json)
{
"name":"Customer Name or integration name",
"compressData":true,
"bucketName":"qualys-pc-data",
"bucketRegion":"us-east-1",
"roleArn":"arn:aws:iam::xxxxxxxx:role/policy-role",
"regenerateExternalId":false
}
Output
{
"messsage":"AWS S3 PC 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_base_url>/partner-integration/aws/s3/{id}/pc""--data""@integration.json""-H""Authorization: Bearer <token>"
“integration.json” contains the request PUT data.
Request PUT Data (integration.json)
{
"name":"Customer Name or integration name",
"compressData":true,
"bucketName":"qualys-pc-data",
"bucketRegion":"us-east-1",
"roleArn":"arn:aws:iam::43890899:role/policy-role",
"regenerateExternalId":true
}
Output
{
"message":"AWS S3 PC Integration successfully updated.",
"externalId":"US_POD_1-1- xxxxxxxx-xxxx-xxxx-xxxxxx-xxxxxxxxxxxxx"
}