Technical Documentation and Interface Q&A for Vulnerability Scanning Services: HTTP Interfaces and External Systems

Data sources for this category include vulnerability scanners, asset inventories, CVE databases, and patch announcements. Update frequency is weekly

What data looks like for this category

Data sources for this category include vulnerability scanners, asset inventories, CVE databases, and patch announcements. Update frequency is weekly or monthly. Daily documents cover scan plans, vulnerability lists, rectification work orders, and rescan reports. Document fields include asset IP addresses, vulnerability CVE numbers, risk levels, repair statuses, rescan results, and more. Most fields are tags, numbers, or text content. No uniform numerical units exist. Field combinations vary across different documents.

Constraints imposed by these characteristics on HTTP interfaces and external systems

Data sources are scattered, and update cycles are long. Interfaces must support incremental synchronization and batch pulling for multiple data sources. Document fields include multiple entity types. Interfaces must support combined multi-field queries and filtering. Error consequences are severe. Interfaces must support idempotent operations and failure retry mechanisms. The business focuses on a tool-based closed loop. Interfaces must adapt to exclusive processes such as scan plan triggering, vulnerability result pulling, and rescan feedback. Interfaces do not need to adapt to additional logic for manual penetration testing.

How to set configurations

Configuration ItemRecommended ValueRationale
AuthorizationBearer {API_KEY}Complies with HTTP authentication specifications, and meets the interface access permission requirements for vulnerability scanning services in FastGPT v4.17.0
variables{"asset_scope": "192.168.1.0/24", "scan_level": "high"}Adapts to dynamic parameter configuration for scan plans, and supports adjusting scan scope and risk level based on business needs
responseData["cve编号", "风险等级", "修复状态", "复扫时间"]Only returns core business fields, optimizes data transmission efficiency, and matches the document structure of vulnerability lists
Timeout Duration600 secondsAdapts to the time consumption requirements of batch vulnerability data pulling, and prevents process interruption due to single request timeout
Retry Count3 timesAddresses network fluctuations or temporary response delays from scanners, and ensures interface call reliability

Three common configuration mistakes

  • The interface returns a 401 Unauthorized error when called. The cause is incorrect configuration of the Authorization parameter, using an invalid or expired API key.
  • Pulling vulnerability data in batches yields a result count that does not match expectations. The cause is failure to limit the asset scope or scan level via the variables parameter, resulting in full redundant data being pulled.
  • Cross-service call timeout occurs during external system docking configuration. The cause is failure to set a reasonable timeout duration, and failure to adapt to the time consumption characteristics of batch data pulling for vulnerability scanning services.

How to confirm correct configuration

  • Call the authentication interface. The interface returns a 200 status code and includes valid session information, confirming that the Authorization parameter is configured correctly.
  • Pass the variables parameter with the specified asset scope, then call the pull interface. The returned results only include vulnerability data for the corresponding assets, confirming that the dynamic parameters take effect.
  • Check the external system docking logs. Confirm that there are no continuous timeouts or interface call retries exceeding 3 times, confirming that the timeout and retry configurations are reasonable.
  • Pull the fields specified in responseData. The returned results only include the preset core business fields, confirming that the data filtering configuration takes effect.

The values provided are common starting points and should be measured against the reader's own samples.

Question material comes from public community discussions. Configuration values are common starting points and should be measured against your own samples. Verified on 2026-10-19.