Create CDR Integration

POST/partner-integration/<cipsProductId>/integration

Create the integration with CDR..

To obtain the ProductId, refer to Create Product.

Input ParametersInput Parameters

Parameter Name Mandatory/Optional Data Type Description

apiEndpoint

Yes

String

Endpoint on which Qualys will send data

authMethod

Yes

String

Type of Authentication - BASIC_AUTH or API_KEY

apiKeyHeaderName

No

String

Default: "x-api-key"

apiKey

Yes 

String

The apiKey used to authenticate

username

Yes (if the authMethod is Basic Auth)

String

Username

password

Yes (if the authMethod is Basic Auth)

String

Password

dataSizeLimit

No

Integer

payload size (in Bytes)

sendTestPayload
OnOnboarding

No

Boolean

Always set it to true, used to validate integration

You can proceed with Basic Auth or API Key for the authentication

Create CDR IntegrationCreate CDR Integration

API Request

curl -X POST '<qualys_gateway_url>/partner-integration/<productId>/integration' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <Token>' \
    

Request POST Data (integration.json)

 "integrationType": "rest_api",
    "apiEndpoint":<Endpoint> ,
    "authMethod": "API_KEY",
    "apiKeyHeaderName": <apiKeyHeaderName>,
    "apiKey": <apiKey>
    "dataSizeLimit":2000,
    "sendTestPayloadOnOnboarding": true
  }

JSON Output

 {   "productName": "cdr",
    "integrationType": "rest_api",
    "integrationValidated": true
}