pycti.rst

pycti

.. automodule:: pycti

   .. contents::
      :local:

.. currentmodule:: pycti

Functions

• :py:func:`get_config_variable`: [summary]

.. autofunction:: get_config_variable

Classes

• :py:class:`AttackPattern`: Undocumented.
• :py:class:`Campaign`: Undocumented.
• :py:class:`CaseIncident`: Undocumented.
• :py:class:`CaseRfi`: Undocumented.
• :py:class:`CaseRft`: Undocumented.
• :py:class:`Task`: Undocumented.
• :py:class:`ConnectorType`: Create a collection of name/value pairs.
• :py:class:`CourseOfAction`: Undocumented.
• :py:class:`DataComponent`: Undocumented.
• :py:class:`DataSource`: Undocumented.
• :py:class:`ExternalReference`: Undocumented.
• :py:class:`Feedback`: Undocumented.
• :py:class:`Grouping`: Undocumented.
• :py:class:`Identity`: Undocumented.
• :py:class:`Incident`: Undocumented.
• :py:class:`Indicator`: Main Indicator class for OpenCTI
• :py:class:`Infrastructure`: Main Infrastructure class for OpenCTI
• :py:class:`IntrusionSet`: Undocumented.
• :py:class:`KillChainPhase`: Undocumented.
• :py:class:`Label`: Undocumented.
• :py:class:`Location`: Undocumented.
• :py:class:`Malware`: Undocumented.
• :py:class:`MalwareAnalysis`: Undocumented.
• :py:class:`MarkingDefinition`: Undocumented.
• :py:class:`Note`: Undocumented.
• :py:class:`ObservedData`: Undocumented.
• :py:class:`OpenCTIApiClient`: Main API client for OpenCTI
• :py:class:`OpenCTIApiConnector`: OpenCTIApiConnector
• :py:class:`OpenCTIApiWork`: OpenCTIApiJob
• :py:class:`OpenCTIConnector`: Main class for OpenCTI connector
• :py:class:`OpenCTIConnectorHelper`: Python API for OpenCTI connector
• :py:class:`OpenCTIMetricHandler`: Undocumented.
• :py:class:`OpenCTIStix2`: Python API for Stix2 in OpenCTI
• :py:class:`OpenCTIStix2Splitter`: Undocumented.
• :py:class:`OpenCTIStix2Update`: Python API for Stix2 Update in OpenCTI
• :py:class:`OpenCTIStix2Utils`: Undocumented.
• :py:class:`Opinion`: Undocumented.
• :py:class:`Report`: Undocumented.
• :py:class:`StixCoreRelationship`: Undocumented.
• :py:class:`StixCyberObservable`: Undocumented.
• :py:class:`StixNestedRefRelationship`: Undocumented.
• :py:class:`StixCyberObservableTypes`: Create a collection of name/value pairs.
• :py:class:`StixDomainObject`: Undocumented.
• :py:class:`StixMetaTypes`: Create a collection of name/value pairs.
• :py:class:`MultipleRefRelationship`: Create a collection of name/value pairs.
• :py:class:`StixObjectOrStixRelationship`: Undocumented.
• :py:class:`StixSightingRelationship`: Undocumented.
• :py:class:`ThreatActor`: Main ThreatActor class for OpenCTI
• :py:class:`ThreatActorGroup`: Main ThreatActorGroup class for OpenCTI
• :py:class:`ThreatActorIndividual`: Main ThreatActorIndividual class for OpenCTI
• :py:class:`Tool`: Undocumented.
• :py:class:`Vulnerability`: Undocumented.
• :py:class:`CustomObjectCaseIncident`: Case-Incident object.
• :py:class:`CustomObjectTask`: Task object.
• :py:class:`CustomObservableHostname`: Hostname observable.
• :py:class:`CustomObservableUserAgent`: User-Agent observable.
• :py:class:`CustomObservableCryptocurrencyWallet`: Cryptocurrency wallet observable.
• :py:class:`CustomObservableText`: Text observable.

.. autoclass:: AttackPattern
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: AttackPattern
      :parts: 1

.. autoclass:: Campaign
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Campaign
      :parts: 1

.. autoclass:: CaseIncident
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CaseIncident
      :parts: 1

.. autoclass:: CaseRfi
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CaseRfi
      :parts: 1

.. autoclass:: CaseRft
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CaseRft
      :parts: 1

.. autoclass:: Task
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Task
      :parts: 1

.. autoclass:: ConnectorType
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ConnectorType
      :parts: 1

.. autoclass:: CourseOfAction
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CourseOfAction
      :parts: 1

.. autoclass:: DataComponent
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: DataComponent
      :parts: 1

.. autoclass:: DataSource
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: DataSource
      :parts: 1

.. autoclass:: ExternalReference
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ExternalReference
      :parts: 1

.. autoclass:: Feedback
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Feedback
      :parts: 1

.. autoclass:: Grouping
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Grouping
      :parts: 1

.. autoclass:: Identity
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Identity
      :parts: 1

.. autoclass:: Incident
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Incident
      :parts: 1

.. autoclass:: Indicator
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Indicator
      :parts: 1

.. autoclass:: Infrastructure
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Infrastructure
      :parts: 1

.. autoclass:: IntrusionSet
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: IntrusionSet
      :parts: 1

.. autoclass:: KillChainPhase
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: KillChainPhase
      :parts: 1

.. autoclass:: Label
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Label
      :parts: 1

.. autoclass:: Location
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Location
      :parts: 1

.. autoclass:: Malware
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Malware
      :parts: 1

.. autoclass:: MalwareAnalysis
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MalwareAnalysis
      :parts: 1

.. autoclass:: MarkingDefinition
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MarkingDefinition
      :parts: 1

.. autoclass:: Note
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Note
      :parts: 1

.. autoclass:: ObservedData
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ObservedData
      :parts: 1

.. autoclass:: OpenCTIApiClient
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIApiClient
      :parts: 1

.. autoclass:: OpenCTIApiConnector
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIApiConnector
      :parts: 1

.. autoclass:: OpenCTIApiWork
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIApiWork
      :parts: 1

.. autoclass:: OpenCTIConnector
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIConnector
      :parts: 1

.. autoclass:: OpenCTIConnectorHelper
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIConnectorHelper
      :parts: 1

.. autoclass:: OpenCTIMetricHandler
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIMetricHandler
      :parts: 1

.. autoclass:: OpenCTIStix2
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2
      :parts: 1

.. autoclass:: OpenCTIStix2Splitter
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2Splitter
      :parts: 1

.. autoclass:: OpenCTIStix2Update
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2Update
      :parts: 1

.. autoclass:: OpenCTIStix2Utils
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: OpenCTIStix2Utils
      :parts: 1

.. autoclass:: Opinion
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Opinion
      :parts: 1

.. autoclass:: Report
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Report
      :parts: 1

.. autoclass:: StixCoreRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixCoreRelationship
      :parts: 1

.. autoclass:: StixCyberObservable
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixCyberObservable
      :parts: 1

.. autoclass:: StixNestedRefRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixNestedRefRelationship
      :parts: 1

.. autoclass:: StixCyberObservableTypes
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixCyberObservableTypes
      :parts: 1

.. autoclass:: StixDomainObject
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixDomainObject
      :parts: 1

.. autoclass:: StixMetaTypes
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixMetaTypes
      :parts: 1

.. autoclass:: MultipleRefRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: MultipleRefRelationship
      :parts: 1

.. autoclass:: StixObjectOrStixRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixObjectOrStixRelationship
      :parts: 1

.. autoclass:: StixSightingRelationship
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: StixSightingRelationship
      :parts: 1

.. autoclass:: ThreatActor
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ThreatActor
      :parts: 1

.. autoclass:: ThreatActorGroup
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ThreatActorGroup
      :parts: 1

.. autoclass:: ThreatActorIndividual
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ThreatActorIndividual
      :parts: 1

.. autoclass:: Tool
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Tool
      :parts: 1

.. autoclass:: Vulnerability
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Vulnerability
      :parts: 1

.. autoclass:: CustomObjectCaseIncident
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObjectCaseIncident
      :parts: 1

.. autoclass:: CustomObjectTask
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObjectTask
      :parts: 1

.. autoclass:: CustomObservableHostname
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableHostname
      :parts: 1

.. autoclass:: CustomObservableUserAgent
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableUserAgent
      :parts: 1

.. autoclass:: CustomObservableCryptocurrencyWallet
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableCryptocurrencyWallet
      :parts: 1

.. autoclass:: CustomObservableText
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: CustomObservableText
      :parts: 1

Variables

• :py:data:`STIX_EXT_MITRE`
• :py:data:`STIX_EXT_OCTI_SCO`
• :py:data:`STIX_EXT_OCTI`

.. autodata:: STIX_EXT_MITRE
   :annotation:

   .. code-block:: text

      'extension-definition--322b8f77-262a-4cb8-a915-1e441e00329b'

.. autodata:: STIX_EXT_OCTI_SCO
   :annotation:

   .. code-block:: text

      'extension-definition--f93e2c80-4231-4f9a-af8b-95c9bd566a82'

.. autodata:: STIX_EXT_OCTI
   :annotation:

   .. code-block:: text

      'extension-definition--ea279b3e-5c71-4632-ac08-831c66a786ba'