Sign in

v1

latestSwagger 2.02026-07-17193256.5 KB
trigger

trigger a playbook by supplying a cacao playbook payload

trigger playbook

post/trigger/playbook

Request body

agent_definitionsCacaoAgentTargets
authentication_info_definitionsCacaoAuthenticationInformations
createdstring required

Timestamp of the creation of the playbook

created_bystring required

UUID referring to identity

data_marking_definitionsCacaoDataMarkings
derived_fromstring[]

Playbook id that this playbook is derived from

descriptionstring

A descriptive text to indicate what your playbook does

extension_definitionsCacaoExtensionDefinitions
idstring required

Used by SOARCA so refer to the object while loading it from the database

impactinteger

A priority number ranging 0 - 100

labelsstring[]

List of labels to label playbook

markingsstring[]

List of datamarking identifiers

modifiedstring required

Timestamp of the last modification of the playbook

namestring required

An indicative name of the playbook

playbook_extensionsCacaoExtensions
playbook_typesstring[]

Should be of the CACAO playbook-type-ov

playbook_variablesCacaoVariables
priorityinteger

A priority number ranging 0 - 100

severityinteger

A priority number ranging 0 - 100

spec_versionstring required

Indicate the specification version cacao-2.0 is the only supported version at this time

target_definitionsCacaoAgentTargets
typestring required

Must be playbook

valid_fromstring

Timestamp from when the playbook is valid

valid_untilstring

Timestamp until when the playbook is valid

workflowCacaoWorkflow required
workflow_exceptionstring

Step that marks the actions that need to be taken when an exception occurs

workflow_startstring required

Start step of the playbook MUST be of step type START

Example request

{
  "created": "2024-01-01T09:00:00.000Z",
  "created_by": "identity--96abab60-238a-44ff-8962-5806aa60cbce",
  "derived_from": [
    "[\"playbook--77c4c428-6304-4950-93ff-83c5224cb67a\"]"
  ],
  "description": "This is an example investigation playbook",
  "id": "playbook--77c4c428-6304-4950-93ff-83c5fd4cb67a",
  "impact": 100,
  "markings": [
    "[marking-statement--6424867b-0440-4885-bd0b-604d51786d06]"
  ],
  "modified": "2024-01-01T09:00:00.000Z",
  "name": "Investigation playbook",
  "playbook_types": [
    "investigation"
  ],
  "priority": 100,
  "severity": 100,
  "spec_version": "cacao-2.0",
  "type": "playbook",
  "valid_from": "2024-01-01T09:00:00.000Z",
  "valid_until": "2124-01-01T09:00:00.000Z",
  "workflow_exception": "end--37bea005-4a36-4a77-bd1f-79a6e4682a13",
  "workflow_start": "start--07bea005-4a36-4a77-bd1f-79a6e4682a13"
}

Response

OK

execution_idstring required
payloadstring required

Example response

{
  "execution_id": "2c855cd6-bbce-402f-a143-3d6eec346c08",
  "payload": "playbook--0cec398c-db69-4f17-bde4-8ecbcc4a8879"
}