:py:mod:`laceworksdk.api.v2.container_registries` ================================================= .. py:module:: laceworksdk.api.v2.container_registries .. autoapi-nested-parse:: Lacework ContainerRegistries API wrapper. Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: laceworksdk.api.v2.container_registries.ContainerRegistriesAPI .. py:class:: ContainerRegistriesAPI(session) Bases: :py:obj:`laceworksdk.api.crud_endpoint.CrudEndpoint` A class used to represent the `Container Registries API endpoint `_ Lacework provides the ability to assess, identify, and report vulnerabilities found in the operating system software packages in a Docker container image. After integrating a container registry in Lacework, Lacework finds all container images in the registry repositories, assesses those container images for software packages with known vulnerabilities, and reports them. .. py:property:: session Get the :class:`HttpSession` instance the object is using. .. py:method:: create(name, type, enabled, data, **request_params) A method to create a new container registry integration. :param name: The name to use to create the container registry integration. :type name: str :param enabled: Whether the integration is enabled. :type enabled: bool|int :param type: The type of the integration. See the `API docs `_ for valid values. :type type: str :param enabled: Whether the object is enabled. :type enabled: bool|int :param data: The definition of the new integration to create. Note this changes depending on the value of the "type" field. See the `API docs `_ for valid values. :type data: dict :param request_params: Use to pass any additional parameters the API :type request_params: dict, optional :returns: Details for the newly created container registry integration :rtype: dict .. py:method:: get(guid=None, type=None) A method to get ContainerRegistries objects. Using no args will get all integrations. :param guid: The GUID of the container registry integration to get. :type guid: str, optional :param type: The type of the container registry integration(s) to get. Valid types are: "ContVulnCfg" :type type: str, optional :returns: The details of the requested integration(s) :rtype: dict .. py:method:: get_by_guid(guid) A method to get a container registry integration by GUID. :param guid: The GUID of the container registry integration to get :type guid: str :returns: The details of the requested integration :rtype: dict .. py:method:: get_by_type(type) A method to get container registry integration(s) by type. :param type: The type of the container registry integration(s) to get. Valid types are: "ContVulnCfg" :type type: str :returns: The details of the requested integration(s) :rtype: dict .. py:method:: update(guid, name=None, type=None, enabled=None, data=None, **request_params) A method to update an ContainerRegistries object. :param guid: A string representing the object GUID. :param name: The name to use to create the container registry integration. :type name: str :param enabled: Whether the integration is enabled. :type enabled: bool|int :param type: The type of the integration. See the `API docs `_ for valid values. :type type: str :param enabled: Whether the object is enabled. :type enabled: bool|int :param data: The definition of the new integration to create. Note this changes depending on the value of the "type" field. See the `API docs `_ for valid values. :type data: dict :param request_params: Use to pass any additional parameters the API :type request_params: dict, optional :returns: Details for the updated container registry integration :rtype: dict .. py:method:: delete(guid) A method to delete a container registry integration . :param guid: The GUID of the container registry integration to delete :type guid: str :returns: a Requests response object containing the response code :rtype: requests.models.Response .. py:method:: search(json=None) A method to search objects. See the API documentation for this API endpoint for valid fields to search against. NOTE: While the "value" and "values" fields are marked as "optional" you must use one of them, depending on the operation you are using. :param json: The desired search parameters: - timeFilter (dict, optional): A dict containing the time frame for the search: - startTime (str): The start time for the search - endTime (str): The end time for the search - filters (list of dict, optional): Filters based on field contents: - field (str): The name of the data field to which the condition applies - expression (str): The comparison operator for the filter condition. Valid values are: "eq", "ne", "in", "not_in", "like", "ilike", "not_like", "not_ilike", "not_rlike", "rlike", "gt", "ge", "lt", "le", "between" - value (str, optional): The value that the condition checks for in the specified field. Use this attribute when using an operator that requires a single value. - values (list of str, optional): The values that the condition checks for in the specified field. Use this attribute when using an operator that requires multiple values. - returns (list of str, optional): The fields to return :type json: dict :returns: returns a dict containing the search results :rtype: dict