APIs to Create and Manage the Integration
The following are the APIs for creating and managing the integration:
|
API |
URL |
Operator |
Description |
|---|---|---|---|
|
/auth |
POST |
Generates a new JWT token. |
|
|
/partner-integration /aws/s3/vm |
POST |
Registers an integration. |
|
|
/partner-integration/aws/s3/{id} /vm/validate |
PATCH |
Enables the integration. |
|
|
/partner-integration/aws/s3/{id}/vm |
PUT |
Updates integration details such as bucket name, bucket region, minSeverity, baseCategory, name, resultSectionNeeded, sendVulnInfo, compressData, and roleArn of the AWS S3 bucket with Qualys. |
|
|
/partner-integration/aws/s3/vm /partner-integration/aws/s3/{id}/vm |
GET |
Gets details of a particular AWS S3 bucket integration. |
|
|
/partner-integration/aws/s3/{id}/vm |
DELETE |
Removes a customer association by deleting the integration details or deregistering the customer. |
URL to the Qualys API Server
Before you proceed with the APIs, you need to know the Qualys API gateway. The Qualys gateway URL you should use for API requests depends on the Qualys platform where your account is located.
Gateway base URLs for different Qualys pods can be found at: https://www.qualys.com/platform-identification/
This document uses <qualys_gateway_url> in sample API requests. Replace this URL with the appropriate Qualys API gateway URL (for example, https://gateway.qg1.apps.qualys.com) for your account.
Related Topics