Fortinet white logo
Fortinet white logo
2024.10.0

How to use the FncApiClient

How to use the FncApiClient

As mentioned in Getting the client, the FncApiClient instance can be created by calling the get_api_client class method of the FncClient class. The FortiNDR Cloud Service exposes REST APIs that can be leveraged to manage the services. The provided Python Client Library and specifically the FncApiClient can be used to access those APIs.

There are two methods that define the main use of the FncApiClient:

  • call_endpoint:

    This method allows you to call specific endpoints provided by the REST APIs exposed by the FortiNDR Cloud Services. The client, simplifies the use of the REST APIs by wrapping all of the required logic and validations into a simple method call. However, it is important to note that not all the endpoints provided by the REST APIs are currently supported by the FncApiClient. The list of supported endpoints can be found in FncClient Library Supported Endpoints.

  • continuous_polling:

    This allows to continuously poll detections from the FortiNDR Cloud Service to be imported into a third-party security solution. The retrieved information could be enriched during the process according to the received arguments.

How to use the FncApiClient

How to use the FncApiClient

As mentioned in Getting the client, the FncApiClient instance can be created by calling the get_api_client class method of the FncClient class. The FortiNDR Cloud Service exposes REST APIs that can be leveraged to manage the services. The provided Python Client Library and specifically the FncApiClient can be used to access those APIs.

There are two methods that define the main use of the FncApiClient:

  • call_endpoint:

    This method allows you to call specific endpoints provided by the REST APIs exposed by the FortiNDR Cloud Services. The client, simplifies the use of the REST APIs by wrapping all of the required logic and validations into a simple method call. However, it is important to note that not all the endpoints provided by the REST APIs are currently supported by the FncApiClient. The list of supported endpoints can be found in FncClient Library Supported Endpoints.

  • continuous_polling:

    This allows to continuously poll detections from the FortiNDR Cloud Service to be imported into a third-party security solution. The retrieved information could be enriched during the process according to the received arguments.