laceworksdk.api.v2.container_registries

Lacework ContainerRegistries API wrapper.

Module Contents

Classes

ContainerRegistriesAPI

A class used to represent the Container Registries API endpoint
class laceworksdk.api.v2.container_registries.ContainerRegistriesAPI(session)[source]

Bases: 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.

property session

Get the HttpSession instance the object is using.

create(name, type, enabled, data, **request_params)[source]

A method to create a new container registry integration.

Parameters:

  • name (str) – The name to use to create the container registry integration.

  • enabled (bool|int) – Whether the integration is enabled.

  • type (str) – The type of the integration. See the API docs for valid values.

  • enabled – Whether the object is enabled.

  • data (dict) –

    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.

  • request_params (dict, optional) – Use to pass any additional parameters the API

Returns:

Details for the newly created container registry integration

Return type:

dict

get(guid=None, type=None)[source]

A method to get ContainerRegistries objects. Using no args will get all integrations.

Parameters:

  • guid (str, optional) – The GUID of the container registry integration to get.

  • type (str, optional) – The type of the container registry integration(s) to get. Valid types are: “ContVulnCfg”

Returns:

The details of the requested integration(s)

Return type:

dict

get_by_guid(guid)[source]

A method to get a container registry integration by GUID.

Parameters:

guid (str) – The GUID of the container registry integration to get

Returns:

The details of the requested integration

Return type:

dict

get_by_type(type)[source]

A method to get container registry integration(s) by type.

Parameters:

type (str) – The type of the container registry integration(s) to get. Valid types are: “ContVulnCfg”

Returns:

The details of the requested integration(s)

Return type:

dict

update(guid, name=None, type=None, enabled=None, data=None, **request_params)[source]

A method to update an ContainerRegistries object.

Parameters:

  • guid – A string representing the object GUID.

  • name (str) – The name to use to create the container registry integration.

  • enabled (bool|int) – Whether the integration is enabled.

  • type (str) –

    The type of the integration. See the API docs for valid values.

  • enabled – Whether the object is enabled.

  • data (dict) –

    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.

  • request_params (dict, optional) – Use to pass any additional parameters the API

Returns:

Details for the updated container registry integration

Return type:

dict

delete(guid)[source]

A method to delete a container registry integration .

Parameters:

guid (str) – The GUID of the container registry integration to delete

Returns:

a Requests response object containing the response code

Return type:

requests.models.Response

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.

Parameters:

json (dict) –

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

Returns:

returns a dict containing the search results

Return type:

dict