Vendor IDs and References

GET POST/api/2.0/fo/vendor/?action=list_vendors

GET POST /api/2.0/fo/vendor/?action=list_vendor_references

This API lists vendor IDs and names related to vulnerabilities in the KnowledgeBase. This vendor information can be used to define dynamic search lists. All users except Auditors have permission to run this API.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={value}

Required

String

Set to “list_vendors” to list vendor IDs and names. Set to “list_vendor_references” to list vendor references for QIDs.

echo_request={0|1}

Optional

Integer 

Specify 1 to view (echo) input parameters in the XML output. By default these are not included.

ids={id1,id2,...}

Optional for action=list

Integer 

One or more vendors IDs to list those vendors only.

qids={qid1,qid2,...}

Optional for action=list_vendor_references

 

One or more QIDs to list vendors references for those QIDs only.

Sample - List Vendor IDs and NamesSample - List Vendor IDs and Names

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""https://<qualys_base_url>/api/2.0/fo/vendor/?action=list_vendors&ids=458,1967"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE VENDOR_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/vendor/vendor_list_output.dtd">
<VENDOR_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2018-04-02T09:23:52Z</DATETIME>
        <VENDORS>
            <VENDOR>
                <ID>458</ID>
                <NAME>
                    <![CDATA[3com]]>
                </NAME>
            </VENDOR>
            <VENDOR>
                <ID>1967</ID>
                <NAME>
                    <![CDATA[2glux]]>
                </NAME>
            </VENDOR>
        </VENDORS>
    </RESPONSE>
</VENDOR_LIST_OUTPUT>

DTD for Vendor List

<platform API server>/api/2.0/fo/vendor/vendor_list_output.dtd

Sample - List Vendor References for QIDsSample - List Vendor References for QIDs

API Request

curl -u "USERNAME:PASSWORD" -H "X-Requested-With: Curl""https://<qualys_base_url>/api/2.0/fo/vendor/?action=list_vendor_references"

XML Output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE VENDOR_REFERENCE_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/vendor/vendor_reference_list_output.dtd">
<VENDOR_REFERENCE_LIST_OUTPUT>
    <RESPONSE>
        <DATETIME>2018-04-02T09:27:34Z</DATETIME>
        <VENDOR_REFERENCES>
            <VENDOR_REFERENCE>
                <QID>195464</QID>
                <REFERENCE_INFO>
                    <REFERENCE>
                        <![CDATA[USN-2186-1]]>
                    </REFERENCE>
                    <URL>
                        <![CDATA[https://lists.ubuntu.com/archives/ubuntu-security-announce/2014-April/002483.html]]>
                    </URL>
                </REFERENCE_INFO>
            </VENDOR_REFERENCE>
            <VENDOR_REFERENCE>
                <QID>115844</QID>
                <REFERENCE_INFO>
                    <REFERENCE>
                        <![CDATA[RHSA-2008-0508]]>
                    </REFERENCE>
                    <URL>
                        <![CDATA[http://rhn.redhat.com/errata/RHSA-2008-0508.html]]>
                    </URL>
                </REFERENCE_INFO>
                <REFERENCE_INFO>
                    <REFERENCE>
                        <![CDATA[RHSA-2008-0519]]>
                    </REFERENCE>
                    <URL>
                        <![CDATA[http://rhn.redhat.com/errata/RHSA-2008-0519.html]]>
                    </URL>
                </REFERENCE_INFO>
            </VENDOR_REFERENCE>
       </VENDOR_REFERENCES>
...
    </RESPONSE>
</VENDOR_REFERENCE_LIST_OUTPUT>

DTD for Vendor Reference List

<platform API server>/api/2.0/fo/vendor/vendor_reference_list_output.dtd