pycti.api.opencti_api_connector

Classes

OpenCTIApiConnector

OpenCTI Connector API class.

Module Contents

class pycti.api.opencti_api_connector.OpenCTIApiConnector(api)[source]

OpenCTI Connector API class.

Manages connector operations including registration, pinging, and listing.

Parameters:

api (OpenCTIApiClient) – instance of OpenCTIApiClient

Initialize the OpenCTIApiConnector instance.

Parameters:

api (OpenCTIApiClient) – OpenCTI API client instance

api[source]
read(connector_id: str) → Dict[source]

Read the connector and its details.

Parameters:

connector_id (str) – the id of the connector

Returns:

return all the connector details

Return type:

dict

list() → List[Dict][source]

List available connectors.

Returns:

list of connector dictionaries

Return type:

list[dict]

ping(connector_id: str, connector_state: Any, connector_info: Dict) → Dict[source]

Ping a connector by ID and state.

Parameters:

  • connector_id (str) – the connector id

  • connector_state (Any) – state for the connector

  • connector_info (dict) – all details about the connector

Returns:

the response pingConnector data dict

Return type:

dict

register(connector: pycti.connector.opencti_connector.OpenCTIConnector) → Dict[source]

Register a connector with OpenCTI.

Parameters:

connector (OpenCTIConnector) – OpenCTIConnector connector object

Returns:

the response registerConnector data dict

Return type:

dict

unregister(_id: str) → Dict[source]

Unregister a connector with OpenCTI.

Parameters:

_id (str) – the connector id to unregister

Returns:

the response deleteConnector data dict

Return type:

dict