Security-Database API Reference : vDNACPE *
The vDNACPE API consists of individual requests and responses, as shown below.
Endpoint WSDL/XSD
API Production (Live) Endpoint |
---|
https://www.security-database.com/get_vdna_soapserver_cpe.php?wsdl |
SOAP Service Endpoints Limitations
For each Security-Database Web Services API service Endpoints, we limit the query request per module as follow :
Production Web Services API Services Endpoints Queries Limitations | ||
---|---|---|
Free and Business | Enterprise | |
vDNACPE() | N/A | 3.000 queries / day |
vDNACPE API Overview
vDNACPE API Overview by Name
API | Purpose |
---|---|
get_cpeProductSummary | Retreive a Summary information for a specified Product or Product/Version that is in your inventory |
vDNACPE API Overview by Name and Function
API Overview by Name and Function and Service Endpoint
SOAP Name | SOAP Request / Response |
---|---|
get_cpeProductSummary | get_cpeProductSummaryIn get_cpeProductSummaryOut |
get_cpeProductSummary
get_cpeProductSummaryIn is your request to retreive a Summary information for a specified Product or Product/Version that is in your inventory
get_cpeProductSummaryIn
vDNACPE API Overview by Field
Element | Description | Data Type | Allowable Values | Required |
---|---|---|---|---|
login | This is your Security-Database User Login | xsd:string | See Description | Yes |
apikey | This is your API Key that you can found in your Security-Database User Panel (menu vDNA API) | xsd:string | 32 single-byte characters | Yes |
modulekey | This is your Module id that you can found in your Security-Database User Panel (menu vDNA API -> modules) | xsd:string | 32 single-byte characters | Yes |
cpeproduct | Your CPE product / Version. Must be CPE compatible : [cC][pP][eE]:/[AHOaho](:[A-Za-z0-9\._\-~%]*){0,6} | xsd:string | See Description | Yes |
cpetype | Specify if the Product is a Full Product (like Mozilla Firefox) '2' or a Product/Version '1' (like Mozilla Firefox 3.6) | xsd:int | 1|2 | Yes |
Example of get_cpeProductSummaryIn
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:get="https://www.security-database.com/get_vdna_soapserver_cpe.php"> <soapenv:Header/> <soapenv:Body> <get:get_cpeProductSummary soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <login xsi:type="xsd:string">testlogin</login> <apikey xsi:type="xsd:string">65de86d2ababdh7D91c42f4f66885d2c</apikey> <modulekey xsi:type="xsd:string">65de86d1ksn10odj1u42f4f66885d211</modulekey> <cpeproduct xsi:type="get:CPEproduct">cpe:/a:sun:jre</cpeproduct> <cpetype xsi:type="xsd:int">2</cpetype> </get:get_cpeProductSummary> </soapenv:Body> </soapenv:Envelope>
get_cpeProductSummaryOut
vDNACPEt API Overview by Field
Element | Description | Data Type | Possible Values |
---|---|---|---|
return | return a complex XML (validation with schema) | tns:wsGetSmallCPEInfosResult | See description |
Example of get_cpeProductSummaryOut
Example of SOAP return. See the third block for the complex XML return with shema validation possibility. Schema available here : https://www.security-database.com/schemas/vdnacpe.xsd
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://www.security-database.com/get_vdna_soapserver_cpe.php" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:get_cpeProductSummaryResponse> <return xsi:type="ns1:wsGetSmallCPEInfosResult"> <lastCVEPublishedDate xsi:type="xsd:date">2012-10-16</lastCVEPublishedDate> <lastCVEModifiedDate xsi:type="xsd:date">2012-12-18</lastCVEModifiedDate> <cve xsi:type="xsd:int">301</cve> <cwe xsi:type="xsd:int">15</cwe> <capec xsi:type="xsd:int">3</capec> <osvdb xsi:type="xsd:int">269</osvdb> <metasploit xsi:type="xsd:int">13</metasploit> <saintexploits xsi:type="xsd:int">9</saintexploits> <milworm xsi:type="xsd:int">2</milworm> <exploitdb xsi:type="xsd:int">15</exploitdb> <iavm xsi:type="xsd:int">1</iavm> <snortrules xsi:type="xsd:int">1</snortrules> </return> </ns1:get_cpeProductSummaryResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>