Skip to content

VulnerabilitiesApi.md

Latest commit

 

History

History
429 lines (300 loc) · 19.9 KB

VulnerabilitiesApi.md

File metadata and controls

429 lines (300 loc) · 19.9 KB

kandji.VulnerabilitiesApi

All URIs are relative to https://<sub_domain>.api.kandji.io

Method HTTP request Description
get_vulnerability_description GET /api/v1/vulnerability-management/vulnerabilities/{cve_id} Get Vulnerability Description
list_affected_devices GET /api/v1/vulnerability-management/vulnerabilities/{cve_id}/devices List Affected Devices
list_affected_software GET /api/v1/vulnerability-management/vulnerabilities/{cve_id}/software List Affected Software
list_detections GET /api/v1/vulnerability-management/detections List Detections
list_vulnerabilities GET /api/v1/vulnerability-management/vulnerabilities List Vulnerabilities

get_vulnerability_description

VulnerabilitiesGetVulnerabilityDescription200Response get_vulnerability_description(cve_id)

Get Vulnerability Description

Retrieve information about a CVE.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.vulnerabilities_get_vulnerability_description200_response import VulnerabilitiesGetVulnerabilityDescription200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.VulnerabilitiesApi(api_client)
    cve_id = 'cve_id_example' # str | 

    try:
        # Get Vulnerability Description
        api_response = api_instance.get_vulnerability_description(cve_id)
        print("The response of VulnerabilitiesApi->get_vulnerability_description:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnerabilitiesApi->get_vulnerability_description: %s\n" % e)

Parameters

Name Type Description Notes
cve_id str

Return type

VulnerabilitiesGetVulnerabilityDescription200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Content-Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_affected_devices

VulnerabilitiesListAffectedDevices200Response list_affected_devices(cve_id, page=page, size=size, sort_by=sort_by, filter=filter)

List Affected Devices

Retrieve a list of devices impacted by a specified cve_id vulnerability for a tenants fleet.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.vulnerabilities_list_affected_devices200_response import VulnerabilitiesListAffectedDevices200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.VulnerabilitiesApi(api_client)
    cve_id = 'cve_id_example' # str | 
    page = '' # str | The page number of the response. (optional)
    size = '50' # str | A hard upper limit is set at 50  records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. (optional)
    sort_by = 'software_name' # str | <p>Field to sort by.</p> <ul> <li>name (device name)</li> <li>detection_datetime</li> </ul> (optional)
    filter = '{\"detection_datetime\":{\"gte\":\"2025-05-23T17:11:31.816587Z\"}}' # str | <p>Filterable columns:</p> <ul> <li>name</li> <li>detection_datetime</li> </ul> (optional)

    try:
        # List Affected Devices
        api_response = api_instance.list_affected_devices(cve_id, page=page, size=size, sort_by=sort_by, filter=filter)
        print("The response of VulnerabilitiesApi->list_affected_devices:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnerabilitiesApi->list_affected_devices: %s\n" % e)

Parameters

Name Type Description Notes
cve_id str
page str The page number of the response. [optional]
size str A hard upper limit is set at 50 records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. [optional]
sort_by str <p>Field to sort by.</p> <ul> <li>name (device name)</li> <li>detection_datetime</li> </ul> [optional]
filter str <p>Filterable columns:</p> <ul> <li>name</li> <li>detection_datetime</li> </ul> [optional]

Return type

VulnerabilitiesListAffectedDevices200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Content-Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_affected_software

VulnerabilitiesListAffectedDevices200Response list_affected_software(cve_id, page=page, size=size, sort_by=sort_by, filter=filter)

List Affected Software

This endpoint makes a request to retrieve a list of software impacted by a specified cve_id vulnerability for a tenant's fleet.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.vulnerabilities_list_affected_devices200_response import VulnerabilitiesListAffectedDevices200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.VulnerabilitiesApi(api_client)
    cve_id = 'cve_id_example' # str | 
    page = '' # str | The page number of the response. (optional)
    size = '50' # str | A hard upper limit is set at 50  records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. (optional)
    sort_by = 'software' # str | <p>Field to sort by.</p> <ul> <li>software (software name)</li> <li>detection_datetime</li> </ul> (optional)
    filter = '{\"detection_datetime\":{\"gte\":\"2025-05-23T17:11:31.816587Z\"}}' # str | <p>Filter results. Similar to prism filters. Filterable columns</p> <ul> <li>blueprint_id</li> <li>detection_datetime</li> </ul> (optional)

    try:
        # List Affected Software
        api_response = api_instance.list_affected_software(cve_id, page=page, size=size, sort_by=sort_by, filter=filter)
        print("The response of VulnerabilitiesApi->list_affected_software:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnerabilitiesApi->list_affected_software: %s\n" % e)

Parameters

Name Type Description Notes
cve_id str
page str The page number of the response. [optional]
size str A hard upper limit is set at 50 records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. [optional]
sort_by str <p>Field to sort by.</p> <ul> <li>software (software name)</li> <li>detection_datetime</li> </ul> [optional]
filter str <p>Filter results. Similar to prism filters. Filterable columns</p> <ul> <li>blueprint_id</li> <li>detection_datetime</li> </ul> [optional]

Return type

VulnerabilitiesListAffectedDevices200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Content-Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_detections

VulnerabilitiesListDetections200Response list_detections(after=after, size=size, filter=filter)

List Detections

Retrieve a list of all vulnerability detections across the device fleet.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.vulnerabilities_list_detections200_response import VulnerabilitiesListDetections200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.VulnerabilitiesApi(api_client)
    after = '' # str | Cursor token. (optional)
    size = '300' # str | A hard upper <code>limit</code> is set at 300  records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. (optional)
    filter = '{\"cve_id\":{\"in\":[\"CVE-2024-24795\"]}}' # str | <p>Filter on any key attribute within the response.</p> <ul> <li>device_id</li> <li>device_name</li> <li>device_serial_number</li> <li>device_model</li> <li>device_os_version</li> <li>blueprint_id</li> <li>blueprint_name</li> <li>name</li> <li>path</li> <li>version</li> <li>bundle_id</li> <li>cve_id</li> <li>cve_description</li> <li>cve_link</li> <li>cvss_score</li> <li>cvss_severity</li> <li>detection_datetime</li> <li>cve_published_at</li> <li>cve_modified_at</li> </ul> (optional)

    try:
        # List Detections
        api_response = api_instance.list_detections(after=after, size=size, filter=filter)
        print("The response of VulnerabilitiesApi->list_detections:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnerabilitiesApi->list_detections: %s\n" % e)

Parameters

Name Type Description Notes
after str Cursor token. [optional]
size str A hard upper <code>limit</code> is set at 300 records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. [optional]
filter str <p>Filter on any key attribute within the response.</p> <ul> <li>device_id</li> <li>device_name</li> <li>device_serial_number</li> <li>device_model</li> <li>device_os_version</li> <li>blueprint_id</li> <li>blueprint_name</li> <li>name</li> <li>path</li> <li>version</li> <li>bundle_id</li> <li>cve_id</li> <li>cve_description</li> <li>cve_link</li> <li>cvss_score</li> <li>cvss_severity</li> <li>detection_datetime</li> <li>cve_published_at</li> <li>cve_modified_at</li> </ul> [optional]

Return type

VulnerabilitiesListDetections200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Content-Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_vulnerabilities

VulnerabilitiesListVulnerabilities200Response list_vulnerabilities(page=page, size=size, sort_by=sort_by, filter=filter)

List Vulnerabilities

Retrieve a list of all vulnerabilities grouped by CVE.

Example

  • Bearer (API Token) Authentication (bearer):
import kandji
from kandji.models.vulnerabilities_list_vulnerabilities200_response import VulnerabilitiesListVulnerabilities200Response
from kandji.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://<sub_domain>.api.kandji.io
# See configuration.py for a list of all supported configuration parameters.
configuration = kandji.Configuration(
    host = "https://<sub_domain>.api.kandji.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Token): bearer
configuration = kandji.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with kandji.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kandji.VulnerabilitiesApi(api_client)
    page = '' # str | The page number of the response. (optional)
    size = '50' # str | A hard upper limit is set at 50  records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. (optional)
    sort_by = 'cve_id' # str | <p>Field to sort by.</p> <ul> <li><p>age</p> </li> <li><p>cve_id</p> </li> <li><p>cvss_score</p> </li> <li><p>device_count</p> </li> <li><p>known_exploit</p> </li> <li><p>software (software name)</p> </li> <li><p>severity</p> </li> <li><p>status</p> </li> </ul> (optional)
    filter = '{\"cve_id\":{\"in\":[\"CVE-2024-24795\"]}}' # str | <p>Filter results. Similar to prism filters. Filterable columns</p> <ul> <li>cve_id</li> <li>software</li> <li>severity</li> <li>first_detection_date</li> <li>status</li> </ul> (optional)

    try:
        # List Vulnerabilities
        api_response = api_instance.list_vulnerabilities(page=page, size=size, sort_by=sort_by, filter=filter)
        print("The response of VulnerabilitiesApi->list_vulnerabilities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VulnerabilitiesApi->list_vulnerabilities: %s\n" % e)

Parameters

Name Type Description Notes
page str The page number of the response. [optional]
size str A hard upper limit is set at 50 records returned per request. If more records are expected, pagination should be used using the URL value returned in the next attribute. Additionally, filters can be added to a request to limit the results. [optional]
sort_by str <p>Field to sort by.</p> <ul> <li><p>age</p> </li> <li><p>cve_id</p> </li> <li><p>cvss_score</p> </li> <li><p>device_count</p> </li> <li><p>known_exploit</p> </li> <li><p>software (software name)</p> </li> <li><p>severity</p> </li> <li><p>status</p> </li> </ul> [optional]
filter str <p>Filter results. Similar to prism filters. Filterable columns</p> <ul> <li>cve_id</li> <li>software</li> <li>severity</li> <li>first_detection_date</li> <li>status</li> </ul> [optional]

Return type

VulnerabilitiesListVulnerabilities200Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK * Content-Type -

[Back to top] [Back to API list] [Back to Model list] [Back to README]