API Reference

This document, Security-Database Web Services API Reference, describes the Security-Database WebServices Application Programming Interface (API) and service.

Intended Audience

This document is written for programmers familiar with Web Services applicationprogramming standards such as the Simple Object Access Protocol (SOAP), the Web ServicesDescription Language (WSDL), and XML Schema Definition (XSD) language.

Security-Database WSDL/XSD Schemas Definitions

The following are the locations of the WSDL and XSD files.

Production Web Services API Services WSDL
getVDNA()https://www.security-database.com/get_vdna_soapserver.php?wsdl
getVDNASingle()https://www.security-database.com/get_vdna_soapserver_single.php?wsdl
getVDNAList()https://www.security-database.com/get_vdna_soapserver_list.php?wsdl
getVDNACvss()https://www.security-database.com/get_vdna_soapserver_cvss.php?wsdl
getVDNACvssv3()https://www.security-database.com/get_vdna_soapserver_cvssv3.php?wsdl
getVDNACPEList()https://www.security-database.com/get_vdna_soapserver_cpelist.php?wsdl
getVDNAOvalID()https://www.security-database.com/get_vdna_soapserver_oval.php?wsdl
getVDNACPEManagement() *https://www.security-database.com/get_vdna_soapserver_cpemanagement.php?wsdl
getVDNACPE() *https://www.security-database.com/get_vdna_soapserver_cpe.php?wsdl
getVDNACPESingle() *https://www.security-database.com/get_vdna_soapserver_cpesingle.php?wsdl

*Only available with Enterprise Subscription

Production Web Services API Services XSD
getVDNA()https://www.security-database.com/schemas/vdna.xsd
getVDNASingle()https://www.security-database.com/schemas/vdnasingle.xsd
getVDNAList()https://www.security-database.com/schemas/vdnalist.xsd
getVDNACvss()https://www.security-database.com/schemas/vdnacvss.xsd
getVDNACvssv3()https://www.security-database.com/schemas/vdnacvssv3.xsd
getVDNACPEList()https://www.security-database.com/schemas/vdnacpelist.xsd
getVDNAovalID()https://www.security-database.com/schemas/vdnaovalid.xsd
getVDNACPEManagement() *https://www.security-database.com/schemas/vdnamanagement.xsd
getVDNACPE() *https://www.security-database.com/schemas/vdnacpe.xsd
getVDNACPESingle() *https://www.security-database.com/schemas/vdnacpesingle.xsd

*Only available with Enterprise Subscription


API Security

The Security-Database Web Services API service is protected to ensure thatonly authorized Security-Database members use it. There are three primary levels of security:

  • API username/password and third-party account authentication
  • Public/private key encryption via an API certificate or API signature
  • Secure Sockets Layer (SSL) data transport

A failure of authenticated security at any one of these levels deniesaccess to the Security-Database Web Services API.

SOAP Service Endpoints

Depending on your chosen action, your SOAP requests must be processedby different service endpoints

Production Web Services API Services Endpoints
getVDNA()https://www.security-database.com/get_vdna_soapserver.php
getVDNASingle()https://www.security-database.com/get_vdna_soapserver_single.php
getVDNAList()https://www.security-database.com/get_vdna_soapserver_list.php
getVDNACvss()https://www.security-database.com/get_vdna_soapserver_cvss.php
getVDNACvssv3()https://www.security-database.com/get_vdna_soapserver_cvssv3.php
getVDNACPEList()https://www.security-database.com/get_vdna_soapserver_cpelist.php
getVDNAOvalID()https://www.security-database.com/get_vdna_soapserver_oval.php
getVDNACPEManagement() *https://www.security-database.com/get_vdna_soapserver_cpemanagement.php
getVDNACPE() *https://www.security-database.com/get_vdna_soapserver_cpe.php
getVDNACPESingle() *https://www.security-database.com/get_vdna_soapserver_cpesingle.php

*Only available with Enterprise Subscription


SOAP Service Endpoints Limitations

Security-Database Web Services API service Endpoints have limited query request per module as follow :

Production Web Services API Services Endpoints Queries Limitations
 Free and BusinessEnterprise
getVDNA()10 queries / day30 queries / day
getVDNASingle()100 queries / day300 queries / day
getVDNAList()Unlimited queries / dayUnlimited queries / day
getVDNACvss()Unlimited queries / dayUnlimited queries / day
getVDNACvssv3()Unlimited queries / dayUnlimited queries / day
getVDNACPEList()Unlimited queries / dayUnlimited queries / day
getVDNAOvalID()5 / day60 / day
getVDNACPEManagement() *--Unlimited queries / day
getVDNACPE() *--3.000 queries / day
getVDNACPESingle() *--3.000 queries / day

*Only available with Enterprise Subscription



SOAP Service Endpoints Documentation

For each Security-Database Web Services API service Endpoints, we provideseparate doculentation

Production Web Services API Services Endpoints Documentation
getVDNA()here
getVDNASingle()here
getVDNAList()here
getVDNACvss()here
getVDNACvssv3()here
getVDNACPEList()here
getVDNAOvalID()here
getVDNACPEManagement() *here
getVDNACPE() *here
getVDNACPESingle() *here

*Only available with Enterprise Subscription


API Overview By Business Function and Service Endpoint

The Security-Database Web Services API consists of individual APIs forspecific business uses, and the individual APIs are grouped into threeservice endpoints

Business FunctionSOAP Request/ResponseProduction (Live) Endpoint
Retreive vDNA
Full informations
get_vdnaIn
get_vdnaOut
https://(...)/get_vdna_soapserver.php
Retreive vDNA
Information for
a single element
get_vdnaCVSSIn
get_vdnaCVSSOut
get_vdnaPublishedDateIn
get_vdnaPublishedDateOut
get_vdnaModifiedDateIn
get_vdnaModifiedDateOut
get_vdnaSDconIn
get_vdnaSDconOut
get_vdnaHistoryIn
get_vdnaHistoryOut
https://(...)/get_vdna_soapserver_single.php
Retreive vDNA
Listing
get_vdnaCVELast10PublishedIn
get_vdnaCVELast10PublishedOut
get_vdnaCVELast10ModifiedIn
get_vdnaCVELast10ModifiedOut
https://(...)/get_vdna_soapserver_list.php
CVSS Calculatorget_cvssscore_withenumerationIn
get_cvssscore_withenumerationOut
get_cvssscore_withvectorIn
get_cvssscore_withvectorOut
https://(...)/get_vdna_soapserver_cvss.php
CVSSv3 Preview 2 Calculatorget_cvssscore_withvectorIn
get_cvssscore_withvectorOut
https://(...)/get_vdna_soapserver_cvssv3.php
Retreive CPEListget_vdnacpevendorlistIn
get_vdnacpevendorlistOut
get_vdnacpeproductlistIn
get_vdnacpeproductlistOut
get_vdnacpeversionlistIn
get_vdnacpeversionlistOut
get_vdnacpesearchlistIn
get_vdnacpesearchlistOut
https://(...)/get_vdna_soapserver_cvssv3.php
Manage Monitoring Products *add_productIn
add_productOut
remove_productIn
remove_productOut
get_inventoryIn
get_inventoryOut
https://(...)/get_vdna_soapserver_cpemanagement.php
Retreive Product Summary *get_cpeProductSummaryIn
get_cpeProductSummaryOut
https://(...)/get_vdna_soapserver_cpe.php
Retreive Alerts listing for a Product *get_cpeProductCveIn
get_cpeProductCveOut
https://(...)/get_vdna_soapserver_cpesingle.php

*Only available with Enterprise Subscription