pycti.api.opencti_api_playbook
==============================

.. py:module:: pycti.api.opencti_api_playbook


Classes
-------

.. autoapisummary::

   pycti.api.opencti_api_playbook.OpenCTIApiPlaybook


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

.. py:class:: OpenCTIApiPlaybook(api)

   OpenCTI Playbook API class.

   Manages playbook operations.

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

   Initialize the OpenCTIApiPlaybook instance.

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


   .. py:attribute:: api


   .. py:method:: playbook_step_execution(playbook: dict, bundle: str)

      Execute a playbook step.

      :param playbook: the playbook configuration dict containing execution_id, event_id,
          execution_start, playbook_id, data_instance_id, step_id, previous_step_id,
          and previous_bundle
      :type playbook: dict
      :param bundle: the STIX bundle to process
      :type bundle: str
      :return: None
      :rtype: None



   .. py:method:: delete(**kwargs)

      Delete a playbook.

      :param id: the playbook id
      :type id: str
      :return: None
      :rtype: None



   .. py:method:: playbook_execute(playbook_id: str, entity_id: str)

      Enroll a playbook on an entity.

      :param playbook_id: the playbook id
      :type playbook_id: str
      :param entity_id: the entity id to enroll the playbook on
      :type entity_id: str
      :return: None
      :rtype: None