pycti.api.opencti_api_connector
===============================

.. py:module:: pycti.api.opencti_api_connector


Classes
-------

.. autoapisummary::

   pycti.api.opencti_api_connector.OpenCTIApiConnector


Module Contents
---------------

.. py:class:: OpenCTIApiConnector(api)

   OpenCTI Connector API class.

   Manages connector operations including registration, pinging, and listing.

   :param api: instance of :py:class:`~pycti.api.opencti_api_client.OpenCTIApiClient`
   :type api: OpenCTIApiClient

   Initialize the OpenCTIApiConnector instance.

   :param api: OpenCTI API client instance
   :type api: OpenCTIApiClient


   .. py:attribute:: api


   .. py:method:: read(connector_id: str) -> Dict

      Read the connector and its details.

      :param connector_id: the id of the connector
      :type connector_id: str
      :return: return all the connector details
      :rtype: dict



   .. py:method:: list() -> List[Dict]

      List available connectors.

      :return: list of connector dictionaries
      :rtype: list[dict]



   .. py:method:: ping(connector_id: str, connector_state: Any, connector_info: Dict) -> Dict

      Ping a connector by ID and state.

      :param connector_id: the connector id
      :type connector_id: str
      :param connector_state: state for the connector
      :type connector_state: Any
      :param connector_info: all details about the connector
      :type connector_info: dict
      :return: the response pingConnector data dict
      :rtype: dict



   .. py:method:: register(connector: pycti.connector.opencti_connector.OpenCTIConnector) -> Dict

      Register a connector with OpenCTI.

      :param connector: OpenCTIConnector connector object
      :type connector: OpenCTIConnector
      :return: the response registerConnector data dict
      :rtype: dict



   .. py:method:: unregister(_id: str) -> Dict

      Unregister a connector with OpenCTI.

      :param _id: the connector id to unregister
      :type _id: str
      :return: the response deleteConnector data dict
      :rtype: dict