.. raw:: html

    <script type="module" src="../_static/js/object_tab_linker.js"> </script>
    <script type="module" src="../_static/js/query_example_selector.js"> </script>

Container Image Vulnerability
=============================

.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    Vulnerability present in the content that is installed in the image.



.. tab-set::
    .. tab-item:: Fields
        
        .. div::
            :name: ``advisory_id``
        
        ``advisory_id`` | String  :bdg-danger:`required` 


        .. dropdown:: String parameters
            :animate: fade-in

            
            ``regex`` | ``^\d{4}:\d{4,}$``
            

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Advisory identifier.

        

        
        .. div::
            :name: ``advisory_type``
        
        ``advisory_type`` | String  :bdg-danger:`required` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Advisory type (RHSA, RHBA, ...).

        

        
        .. div::
            :name: ``cve_id``
        
        ``cve_id`` | String  :bdg-danger:`required` 


        .. dropdown:: String parameters
            :animate: fade-in

            
            ``regex`` | ``^CVE-\d{4}-\d{4,}$``
            

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            ID of the CVE.

        

        
        .. div::
            :name: ``public_date``
        
        ``public_date`` | String  :bdg-danger:`required` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Date the CVE was made public.

        

        
        .. div::
            :name: ``severity``
        
        ``severity`` | String  :bdg-danger:`required` 


        .. dropdown:: String parameters
            :animate: fade-in

            ``enum`` Low | Moderate | Important | Critical

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            CVE severity.

        

        
        .. div::
            :name: ``object_type``
        
        ``object_type`` | String 


        .. dropdown:: String parameters
            :animate: fade-in

            ``constant`` | containerImageVulnerability
            

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            

        

        
        .. div::
            :name: ``packages``
        

        ``packages`` | List[:doc:`/objects/ContainerImageVulnerabilityPackage`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Array of package information applicable to this CVE. This array was superseded by affected_packages array.

        

        
        .. div::
            :name: ``affected_packages``
        

        ``affected_packages`` | List[:doc:`/objects/ContainerImageVulnerabilityAffectedPackage`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            List of packages affected by this CVE.

        

        
        .. div::
            :name: ``_id``
        ``_id`` | :doc:`/scalars/ObjectID` :bdg-primary-line:`read-only`

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            MongoDB unique _id

        

        
        .. div::
            :name: ``creation_date``
        
        ``creation_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date when the entry was created. Value is created automatically on creation.

        

        
        .. div::
            :name: ``last_update_date``
        
        ``last_update_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date when the entry was last updated.

        

        

    


    .. tab-item:: Indexes

        

            

            
            .. div::
                :name: ``vulnerability_identity``

            ``vulnerability_identity``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``advisory_id: ASC``
                - ``cve_id: ASC``
                - ``image_id: ASC``

            
            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Parameters
                - ``unique: True``
                - ``sparse: True``
            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This unique index is used to find container image vulnerability by combination of advisory_id, cve_id and image_id.
                |
            .. div::
                :name: ``image_id_1_severity_1``

            ``image_id_1_severity_1``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``image_id: ASC``
                - ``severity: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find container image vulnerability by image_id and severity.
                |

        

    

    

    .. tab-item:: Usage

        .. dropdown:: Endpoints
            :animate: fade-in

            

            - :doc:`GET - /vulnerabilities/id/{identifier} </endpoints/RESTGetVulnerability>`

            - :doc:`GET - /images/id/{identifier}/vulnerabilities </endpoints/RESTGetVulnerabilitiesByImageID>`

        .. dropdown:: Queries and Mutations
            :animate: fade-in

            

            - :doc:`get_image_vulnerability </queries/get_image_vulnerability>`

            - :doc:`find_image_vulnerabilities </queries/find_image_vulnerabilities>`