MitreCaldera

Mitre Caldera can be used to test endpoint security solutions and assess a network's security posture against the common post-compromise adversarial techniques contained in the ATT&CK model. CALDERA leverages the ATT&CK model to identify and replicate adversary behaviors as if a real intrusion is occurring.

IT Services · MITRE Caldera

Details

IDMitreCaldera
ProviderMITRE Corporation
CategoryIT Services
From Version6.2.0
Docker Imagedemisto/python3:3.12.8.3296088
Supported ModulesAgentix XSIAM

README

Mitre Caldera can be used to test endpoint security solutions and assess a network’s security posture against the common post-compromise adversarial techniques contained in the ATT&CK model. CALDERA leverages the ATT&CK model to identify and replicate adversary behaviors as if a real intrusion is occurring.
This integration was integrated and tested with version 4.0.0 of MitreCaldera

Configure MitreCaldera in Cortex

Parameter Required
Server URL (e.g. https://www.example.com:8888) True
API Key True
Trust any certificate (not secure) False
Use system proxy settings False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

caldera-create-fact

Create a Fact

Base Command

caldera-create-fact

Input

Argument Name Description Required
fact_name Fact name. Optional
fact_links Fact links (CSV of IDs). Optional
fact_relationships Fact relationships (CSV of IDs). Optional
fact_origin_type Fact origin type. Optional
fact_limit_count Fact limit count. Optional
fact_technique_id Fact technique ID. Optional
fact_trait Fact trait. Required
fact_source Fact source. Optional
fact_score Fact score. Optional
fact_value Fact value. Optional

Context Output

Path Type Description
MitreCaldera.Facts.unique String  
MitreCaldera.Facts.name String  
MitreCaldera.Facts.created String  
MitreCaldera.Facts.limit_count Number  
MitreCaldera.Facts.technique_id String  
MitreCaldera.Facts.trait String  
MitreCaldera.Facts.source String  
MitreCaldera.Facts.score Number  

caldera-create-fact-source

Create a Fact Source.

Base Command

caldera-create-fact-source

Input

Argument Name Description Required
name Name. Optional
adjustments Adjustments (array of adjustment objects). Optional
relationships Relationships (array of relationship objects). Optional
rules Rules (array of rule objects). Optional
facts Facts (array of fact objects). Optional
plugin Plugin. Optional

Context Output

Path Type Description
MitreCaldera.Sources.name String  
MitreCaldera.Sources.adjustments.ability_id String  
MitreCaldera.Sources.adjustments.offset Number  
MitreCaldera.Sources.adjustments.trait String  
MitreCaldera.Sources.adjustments.value String  
MitreCaldera.Sources.relationships.unique String  
MitreCaldera.Sources.relationships.origin String  
MitreCaldera.Sources.relationships.edge String  
MitreCaldera.Sources.relationships.score Number  
MitreCaldera.Sources.id String  
MitreCaldera.Sources.rules.trait String  
MitreCaldera.Sources.rules.match String  
MitreCaldera.Sources.facts.unique String  
MitreCaldera.Sources.facts.name String  
MitreCaldera.Sources.facts.created String  
MitreCaldera.Sources.facts.limit_count Number  
MitreCaldera.Sources.facts.technique_id String  
MitreCaldera.Sources.facts.trait String  
MitreCaldera.Sources.facts.source String  
MitreCaldera.Sources.facts.score Number  
MitreCaldera.Sources.plugin String  

caldera-create-adversary

Create a new adversary

Base Command

caldera-create-adversary

Input

Argument Name Description Required
name Adversary name. Optional
tags Tags (CSV of tag names). Optional
objective Objective. Optional
atomic_ordering Atomic ordering (CSV of ability IDs). Optional
plugin Plugin. Optional
description Description. Optional

Context Output

Path Type Description
MitreCaldera.Adversaries.name String  
MitreCaldera.Adversaries.objective String  
MitreCaldera.Adversaries.adversary_id String  
MitreCaldera.Adversaries.has_repeatable_abilities Boolean  
MitreCaldera.Adversaries.plugin String  
MitreCaldera.Adversaries.description String  

caldera-create-agent

Create a new agent

Base Command

caldera-create-agent

Input

Argument Name Description Required
watchdog Watchdog timer. Optional
deadman_enabled Deadman enabled (true or false). Possible values are: false, true. Default is false. Optional
ppid PPID. Optional
pid PID. Optional
proxy_receivers Proxy Receivers (JSON dict). Optional
origin_link_id Origin link ID. Optional
available_contacts Available contacts (CSV of contact IDs). Optional
platform Platform. Optional
host Host. Optional
group Group. Optional
location Location. Optional
display_name Display name. Optional
upstream_dest Upstream destination. Optional
host_ip_addrs Host IP addresses (CSV of IP addresses). Optional
sleep_max Sleep maximum. Optional
architecture Architecture. Optional
sleep_min Sleep minimum. Optional
server Server. Optional
contact Contact. Optional
exeutors Executors (CSV of executor IDs). Optional
privilege Privilege. Optional
username Username. Optional
trusted Trusted. Possible values are: false, true. Default is true. Optional
proxy_chain Proxy chain (array of proxy arrays). Optional
paw Agent PAW. Optional
exe_name EXE name. Optional

Context Output

Path Type Description
MitreCaldera.Agents.watchdog Number  
MitreCaldera.Agents.links.relationships.unique String  
MitreCaldera.Agents.links.relationships.origin String  
MitreCaldera.Agents.links.relationships.edge String  
MitreCaldera.Agents.links.relationships.score Number  
MitreCaldera.Agents.links.id String  
MitreCaldera.Agents.links.collect String  
MitreCaldera.Agents.links.pid String  
MitreCaldera.Agents.links.finish String  
MitreCaldera.Agents.links.pin Number  
MitreCaldera.Agents.links.jitter Number  
MitreCaldera.Agents.links.agent_reported_time String  
MitreCaldera.Agents.links.deadman Boolean  
MitreCaldera.Agents.links.used.unique String  
MitreCaldera.Agents.links.used.name String  
MitreCaldera.Agents.links.used.created String  
MitreCaldera.Agents.links.used.limit_count Number  
MitreCaldera.Agents.links.used.technique_id String  
MitreCaldera.Agents.links.used.trait String  
MitreCaldera.Agents.links.used.source String  
MitreCaldera.Agents.links.used.score Number  
MitreCaldera.Agents.links.host String  
MitreCaldera.Agents.links.status Number  
MitreCaldera.Agents.links.score Number  
MitreCaldera.Agents.links.command String  
MitreCaldera.Agents.links.unique String  
MitreCaldera.Agents.links.cleanup Number  
MitreCaldera.Agents.links.decide String  
MitreCaldera.Agents.links.facts.unique String  
MitreCaldera.Agents.links.facts.name String  
MitreCaldera.Agents.links.facts.created String  
MitreCaldera.Agents.links.facts.limit_count Number  
MitreCaldera.Agents.links.facts.technique_id String  
MitreCaldera.Agents.links.facts.trait String  
MitreCaldera.Agents.links.facts.source String  
MitreCaldera.Agents.links.facts.score Number  
MitreCaldera.Agents.links.paw String  
MitreCaldera.Agents.links.output String  
MitreCaldera.Agents.deadman_enabled Boolean  
MitreCaldera.Agents.ppid Number  
MitreCaldera.Agents.pid Number  
MitreCaldera.Agents.created String  
MitreCaldera.Agents.origin_link_id String  
MitreCaldera.Agents.last_seen String  
MitreCaldera.Agents.platform String  
MitreCaldera.Agents.pending_contact String  
MitreCaldera.Agents.host String  
MitreCaldera.Agents.group String  
MitreCaldera.Agents.location String  
MitreCaldera.Agents.display_name String  
MitreCaldera.Agents.upstream_dest String  
MitreCaldera.Agents.sleep_max Number  
MitreCaldera.Agents.architecture String  
MitreCaldera.Agents.sleep_min Number  
MitreCaldera.Agents.server String  
MitreCaldera.Agents.contact String  
MitreCaldera.Agents.privilege String  
MitreCaldera.Agents.username String  
MitreCaldera.Agents.trusted Boolean  
MitreCaldera.Agents.proxy_chain String  
MitreCaldera.Agents.paw String  
MitreCaldera.Agents.exe_name String  

caldera-create-operation

Create a new CALDERA operation record

Base Command

caldera-create-operation

Input

Argument Name Description Required
name Operation name. Required
autonomous Autonomous (autonomous or manual). Possible values are: autonomous, manual. Default is autonomous. Optional
objective_id Objective ID. Optional
visibility How visible should the operation be to the defense (1-100), default is 51. Optional
state State. Possible values are: running, paused, run_one_link. Default is running. Optional
group Group. Optional
host_group Host group. Optional
planner_id Planner ID. Required
obfuscator Obfuscator. Possible values are: base64, base64jumble, base64noPadding, caesar cipher, plain-text, steganography. Default is plain-text. Optional
use_learning_parsers Use learning parsers. Possible values are: false, true. Default is false. Optional
source_id Source ID. Required
jitter Jitter is defined as a fraction (default is “2/8”). Optional
adversary_id adversary id. Required
auto_close Auto close. Possible values are: false, true. Default is false. Optional

Context Output

Path Type Description
MitreCaldera.Operations.name String  
MitreCaldera.Operations.autonomous Number  
MitreCaldera.Operations.id String  
MitreCaldera.Operations.visibility Number  
MitreCaldera.Operations.state String  
MitreCaldera.Operations.group String  
MitreCaldera.Operations.host_group.watchdog Number  
MitreCaldera.Operations.host_group.links.relationships.unique String  
MitreCaldera.Operations.host_group.links.relationships.origin String  
MitreCaldera.Operations.host_group.links.relationships.edge String  
MitreCaldera.Operations.host_group.links.relationships.score Number  
MitreCaldera.Operations.host_group.links.id String  
MitreCaldera.Operations.host_group.links.collect String  
MitreCaldera.Operations.host_group.links.pid String  
MitreCaldera.Operations.host_group.links.finish String  
MitreCaldera.Operations.host_group.links.pin Number  
MitreCaldera.Operations.host_group.links.jitter Number  
MitreCaldera.Operations.host_group.links.agent_reported_time String  
MitreCaldera.Operations.host_group.links.deadman Boolean  
MitreCaldera.Operations.host_group.links.used.unique String  
MitreCaldera.Operations.host_group.links.used.name String  
MitreCaldera.Operations.host_group.links.used.created String  
MitreCaldera.Operations.host_group.links.used.limit_count Number  
MitreCaldera.Operations.host_group.links.used.technique_id String  
MitreCaldera.Operations.host_group.links.used.trait String  
MitreCaldera.Operations.host_group.links.used.source String  
MitreCaldera.Operations.host_group.links.used.score Number  
MitreCaldera.Operations.host_group.links.host String  
MitreCaldera.Operations.host_group.links.status Number  
MitreCaldera.Operations.host_group.links.score Number  
MitreCaldera.Operations.host_group.links.command String  
MitreCaldera.Operations.host_group.links.unique String  
MitreCaldera.Operations.host_group.links.cleanup Number  
MitreCaldera.Operations.host_group.links.decide String  
MitreCaldera.Operations.host_group.links.facts.unique String  
MitreCaldera.Operations.host_group.links.facts.name String  
MitreCaldera.Operations.host_group.links.facts.created String  
MitreCaldera.Operations.host_group.links.facts.limit_count Number  
MitreCaldera.Operations.host_group.links.facts.technique_id String  
MitreCaldera.Operations.host_group.links.facts.trait String  
MitreCaldera.Operations.host_group.links.facts.source String  
MitreCaldera.Operations.host_group.links.facts.score Number  
MitreCaldera.Operations.host_group.links.paw String  
MitreCaldera.Operations.host_group.links.output String  
MitreCaldera.Operations.host_group.deadman_enabled Boolean  
MitreCaldera.Operations.host_group.ppid Number  
MitreCaldera.Operations.host_group.pid Number  
MitreCaldera.Operations.host_group.created String  
MitreCaldera.Operations.host_group.origin_link_id String  
MitreCaldera.Operations.host_group.last_seen String  
MitreCaldera.Operations.host_group.platform String  
MitreCaldera.Operations.host_group.pending_contact String  
MitreCaldera.Operations.host_group.host String  
MitreCaldera.Operations.host_group.group String  
MitreCaldera.Operations.host_group.location String  
MitreCaldera.Operations.host_group.display_name String  
MitreCaldera.Operations.host_group.upstream_dest String  
MitreCaldera.Operations.host_group.sleep_max Number  
MitreCaldera.Operations.host_group.architecture String  
MitreCaldera.Operations.host_group.sleep_min Number  
MitreCaldera.Operations.host_group.server String  
MitreCaldera.Operations.host_group.contact String  
MitreCaldera.Operations.host_group.privilege String  
MitreCaldera.Operations.host_group.username String  
MitreCaldera.Operations.host_group.trusted Boolean  
MitreCaldera.Operations.host_group.proxy_chain String  
MitreCaldera.Operations.host_group.paw String  
MitreCaldera.Operations.host_group.exe_name String  
MitreCaldera.Operations.obfuscator String  
MitreCaldera.Operations.use_learning_parsers Boolean  
MitreCaldera.Operations.jitter String  
MitreCaldera.Operations.start String  
MitreCaldera.Operations.auto_close Boolean  

caldera-create-objective

Create a new objective

Base Command

caldera-create-objective

Input

Argument Name Description Required
name Objective name. Optional
goals Goals (array of objective objects). Optional
description Description. Optional

Context Output

Path Type Description
MitreCaldera.Objectives.name String  
MitreCaldera.Objectives.id String  
MitreCaldera.Objectives.percentage Unknown  
MitreCaldera.Objectives.goals.count Number  
MitreCaldera.Objectives.goals.achieved Boolean  
MitreCaldera.Objectives.goals.operator String  
MitreCaldera.Objectives.goals.value String  
MitreCaldera.Objectives.goals.target String  
MitreCaldera.Objectives.description String  

caldera-create-relationship

Create a Relationship

Base Command

caldera-create-relationship

Input

Argument Name Description Required
relationship_unique . Optional
relationship_origin . Optional
relationship_edge . Optional
relationship_source_unique relationship_source unique. Optional
relationship_source_name relationship_source name. Optional
relationship_source_links relationship_source links. Optional
relationship_source_relationships relationship_source relationships. Optional
relationship_source_origin_type relationship_source origin_type. Optional
relationship_source_created relationship_source created. Optional
relationship_source_limit_count relationship_source limit_count. Optional
relationship_source_technique_id relationship_source technique_id. Optional
relationship_source_trait relationship_source trait. Required
relationship_source_source relationship_source source. Optional
relationship_source_score relationship_source score. Optional
relationship_source_value relationship_source value. Optional
relationship_source_collected_by relationship_source collected_by. Optional
relationship_score . Optional
relationship_target . Optional

Context Output

Path Type Description
MitreCaldera.Relationship.unique String  
MitreCaldera.Relationship.origin String  
MitreCaldera.Relationship.edge String  
MitreCaldera.Relationship.score Number  

caldera-create-ability

Creates a new ability.

Base Command

caldera-create-ability

Input

Argument Name Description Required
ability_ability_id . Optional
ability_name . Optional
ability_buckets . Optional
ability_technique_id . Optional
ability_delete_payload . Optional
ability_executors . Optional
ability_privilege . Optional
ability_requirements . Optional
ability_plugin . Optional
ability_access . Optional
ability_tactic . Optional
ability_additional_info . Optional
ability_singleton . Optional
ability_technique_name . Optional
ability_repeatable . Optional
ability_description . Optional

Context Output

Path Type Description
MitreCaldera.Abilities.ability_id String  
MitreCaldera.Abilities.name String  
MitreCaldera.Abilities.technique_id String  
MitreCaldera.Abilities.delete_payload Boolean  
MitreCaldera.Abilities.executors.name String  
MitreCaldera.Abilities.executors.platform String  
MitreCaldera.Abilities.executors.language String  
MitreCaldera.Abilities.executors.variations.command String  
MitreCaldera.Abilities.executors.variations.description String  
MitreCaldera.Abilities.executors.build_target String  
MitreCaldera.Abilities.executors.timeout Number  
MitreCaldera.Abilities.executors.parsers.module String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.edge String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.source String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.target String  
MitreCaldera.Abilities.executors.command String  
MitreCaldera.Abilities.executors.code String  
MitreCaldera.Abilities.privilege String  
MitreCaldera.Abilities.requirements.module String  
MitreCaldera.Abilities.plugin String  
MitreCaldera.Abilities.tactic String  
MitreCaldera.Abilities.singleton Boolean  
MitreCaldera.Abilities.technique_name String  
MitreCaldera.Abilities.repeatable Boolean  
MitreCaldera.Abilities.description String  

caldera-create-potential-link

Creates a potential Link

Base Command

caldera-create-potential-link

Input

Argument Name Description Required
operation_id UUID of the operation object for the link to be created on. Required
link_relationships . Optional
link_id . Optional
link_collect . Optional
link_pid . Optional
link_visibility_adjustments link_visibility adjustments. Optional
link_visibility_score link_visibility score. Optional
link_finish . Optional
link_pin . Optional
link_jitter . Optional
link_agent_reported_time . Optional
link_deadman . Optional
link_used . Optional
link_host . Optional
link_ability_ability_id link_ability ability_id. Optional
link_ability_name link_ability name. Optional
link_ability_buckets link_ability buckets. Optional
link_ability_technique_id link_ability technique_id. Optional
link_ability_delete_payload link_ability delete_payload. Optional
link_ability_executors link_ability executors. Optional
link_ability_privilege link_ability privilege. Optional
link_ability_requirements link_ability requirements. Optional
link_ability_plugin link_ability plugin. Optional
link_ability_access link_ability access. Optional
link_ability_tactic link_ability tactic. Optional
link_ability_additional_info link_ability additional_info. Optional
link_ability_singleton link_ability singleton. Optional
link_ability_technique_name link_ability technique_name. Optional
link_ability_repeatable link_ability repeatable. Optional
link_ability_description link_ability description. Optional
link_status . Optional
link_score . Optional
link_command . Optional
link_unique . Optional
link_cleanup . Optional
link_decide . Optional
link_facts . Optional
link_executor_name link_executor name. Optional
link_executor_cleanup link_executor cleanup. Optional
link_executor_platform link_executor platform. Optional
link_executor_language link_executor language. Optional
link_executor_uploads link_executor uploads. Optional
link_executor_variations link_executor variations. Optional
link_executor_build_target link_executor build_target. Optional
link_executor_payloads link_executor payloads. Optional
link_executor_timeout link_executor timeout. Optional
link_executor_parsers link_executor parsers. Optional
link_executor_command link_executor command. Optional
link_executor_additional_info link_executor additional_info. Optional
link_executor_code link_executor code. Optional
link_paw . Optional
link_output . Optional

Context Output

Path Type Description
MitreCaldera.Links.relationships.unique String  
MitreCaldera.Links.relationships.origin String  
MitreCaldera.Links.relationships.edge String  
MitreCaldera.Links.relationships.score Number  
MitreCaldera.Links.id String  
MitreCaldera.Links.collect String  
MitreCaldera.Links.pid String  
MitreCaldera.Links.finish String  
MitreCaldera.Links.pin Number  
MitreCaldera.Links.jitter Number  
MitreCaldera.Links.agent_reported_time String  
MitreCaldera.Links.deadman Boolean  
MitreCaldera.Links.used.unique String  
MitreCaldera.Links.used.name String  
MitreCaldera.Links.used.created String  
MitreCaldera.Links.used.limit_count Number  
MitreCaldera.Links.used.technique_id String  
MitreCaldera.Links.used.trait String  
MitreCaldera.Links.used.source String  
MitreCaldera.Links.used.score Number  
MitreCaldera.Links.host String  
MitreCaldera.Links.status Number  
MitreCaldera.Links.score Number  
MitreCaldera.Links.command String  
MitreCaldera.Links.unique String  
MitreCaldera.Links.cleanup Number  
MitreCaldera.Links.decide String  
MitreCaldera.Links.facts.unique String  
MitreCaldera.Links.facts.name String  
MitreCaldera.Links.facts.created String  
MitreCaldera.Links.facts.limit_count Number  
MitreCaldera.Links.facts.technique_id String  
MitreCaldera.Links.facts.trait String  
MitreCaldera.Links.facts.source String  
MitreCaldera.Links.facts.score Number  
MitreCaldera.Links.paw String  
MitreCaldera.Links.output String  

caldera-create-schedule

Create Schedule

Base Command

caldera-create-schedule

Input

Argument Name Description Required
schedule_schedule . Required
schedule_task_name schedule_task name. Optional
schedule_task_autonomous schedule_task autonomous. Optional
schedule_task_id schedule_task id. Optional
schedule_task_objective schedule_task objective. Optional
schedule_task_visibility schedule_task visibility. Optional
schedule_task_state schedule_task state. Optional
schedule_task_group schedule_task group. Optional
schedule_task_host_group schedule_task host_group. Optional
schedule_task_planner schedule_task planner. Optional
schedule_task_obfuscator schedule_task obfuscator. Optional
schedule_task_chain schedule_task chain. Optional
schedule_task_use_learning_parsers schedule_task use_learning_parsers. Optional
schedule_task_source schedule_task source. Optional
schedule_task_jitter schedule_task jitter. Optional
schedule_task_start schedule_task start. Optional
schedule_task_adversary schedule_task adversary. Optional
schedule_task_auto_close schedule_task auto_close. Optional
schedule_id . Optional

Context Output

Path Type Description
MitreCaldera.Schedule.schedule String  
MitreCaldera.Schedule.id String  

caldera-delete-agent

Delete an Agent

Base Command

caldera-delete-agent

Input

Argument Name Description Required
paw paw of the Agent to be deleted. Required

Context Output

There is no context output for this command.

caldera-delete-fact-source

Delete an existing Fact Source.

Base Command

caldera-delete-fact-source

Input

Argument Name Description Required
fact_source_id The id of the Fact Source to be deleted. Required

Context Output

There is no context output for this command.

caldera-delete-operation

Delete an operation by operation id

Base Command

caldera-delete-operation

Input

Argument Name Description Required
operation_id UUID of the Operation object to be retrieved. Required

Context Output

There is no context output for this command.

caldera-delete-facts

Delete One or More Facts

Base Command

caldera-delete-facts

Input

Argument Name Description Required
fact_unique . Optional
fact_name . Optional
fact_links . Optional
fact_relationships . Optional
fact_origin_type . Optional
fact_created . Optional
fact_limit_count . Optional
fact_technique_id . Optional
fact_trait . Optional
fact_source . Optional
fact_score . Optional
fact_value . Optional
fact_collected_by . Optional

Context Output

Path Type Description
MitreCaldera.Facts.unique String  
MitreCaldera.Facts.name String  
MitreCaldera.Facts.created String  
MitreCaldera.Facts.limit_count Number  
MitreCaldera.Facts.technique_id String  
MitreCaldera.Facts.trait String  
MitreCaldera.Facts.source String  
MitreCaldera.Facts.score Number  

caldera-delete-relationships

Delete One or More Relationships

Base Command

caldera-delete-relationships

Input

Argument Name Description Required
relationship_unique . Optional
relationship_origin . Optional
relationship_edge . Optional
relationship_source_unique relationship_source unique. Optional
relationship_source_name relationship_source name. Optional
relationship_source_links relationship_source links. Optional
relationship_source_relationships relationship_source relationships. Optional
relationship_source_origin_type relationship_source origin_type. Optional
relationship_source_created relationship_source created. Optional
relationship_source_limit_count relationship_source limit_count. Optional
relationship_source_technique_id relationship_source technique_id. Optional
relationship_source_trait relationship_source trait. Optional
relationship_source_source relationship_source source. Optional
relationship_source_score relationship_source score. Optional
relationship_source_value relationship_source value. Optional
relationship_source_collected_by relationship_source collected_by. Optional
relationship_score . Optional
relationship_target . Optional

Context Output

Path Type Description
MitreCaldera.Relationship.unique String  
MitreCaldera.Relationship.origin String  
MitreCaldera.Relationship.edge String  
MitreCaldera.Relationship.score Number  

caldera-delete-ability

Deletes an ability.

Base Command

caldera-delete-ability

Input

Argument Name Description Required
ability_id UUID of the Ability to be deleted. Required

Context Output

There is no context output for this command.

caldera-delete-adversary

Deletes an adversary.

Base Command

caldera-delete-adversary

Input

Argument Name Description Required
adversary_id UUID of the adversary to be deleted. Required

Context Output

There is no context output for this command.

caldera-delete-schedule

Delete Schedule

Base Command

caldera-delete-schedule

Input

Argument Name Description Required
schedule_id UUID of the Schedule to be deleted. Required

Context Output

There is no context output for this command.

caldera-get-abilities

Get all Abilities with optional ability ID.

Base Command

caldera-get-abilities

Input

Argument Name Description Required
ability_id Optional UUID of the Ability to be retrieved. Optional
sort Results are sorted if no Ability ID is provided. Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Abilities.ability_id String  
MitreCaldera.Abilities.name String  
MitreCaldera.Abilities.technique_id String  
MitreCaldera.Abilities.delete_payload Boolean  
MitreCaldera.Abilities.executors.name String  
MitreCaldera.Abilities.executors.platform String  
MitreCaldera.Abilities.executors.language String  
MitreCaldera.Abilities.executors.variations.command String  
MitreCaldera.Abilities.executors.variations.description String  
MitreCaldera.Abilities.executors.build_target String  
MitreCaldera.Abilities.executors.timeout Number  
MitreCaldera.Abilities.executors.parsers.module String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.edge String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.source String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.target String  
MitreCaldera.Abilities.executors.command String  
MitreCaldera.Abilities.executors.code String  
MitreCaldera.Abilities.privilege String  
MitreCaldera.Abilities.requirements.module String  
MitreCaldera.Abilities.plugin String  
MitreCaldera.Abilities.tactic String  
MitreCaldera.Abilities.singleton Boolean  
MitreCaldera.Abilities.technique_name String  
MitreCaldera.Abilities.repeatable Boolean  
MitreCaldera.Abilities.description String  

caldera-get-adversaries

Get all Adversaries with optional Adversary ID

Base Command

caldera-get-adversaries

Input

Argument Name Description Required
adversary_id Optional UUID of the adversary to be retrieved. Optional
sort Results are sorted if no Adversary ID is provided. Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Adversaries.name String  
MitreCaldera.Adversaries.objective String  
MitreCaldera.Adversaries.adversary_id String  
MitreCaldera.Adversaries.has_repeatable_abilities Boolean  
MitreCaldera.Adversaries.plugin String  
MitreCaldera.Adversaries.description String  

caldera-get-agents

Retrieves all agents with optional Agent PAW

Base Command

caldera-get-agents

Input

Argument Name Description Required
paw Optioanl PAW ID of the Agent to retrieve information about. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Agents.watchdog Number  
MitreCaldera.Agents.links.relationships.unique String  
MitreCaldera.Agents.links.relationships.origin String  
MitreCaldera.Agents.links.relationships.edge String  
MitreCaldera.Agents.links.relationships.score Number  
MitreCaldera.Agents.links.id String  
MitreCaldera.Agents.links.collect String  
MitreCaldera.Agents.links.pid String  
MitreCaldera.Agents.links.finish String  
MitreCaldera.Agents.links.pin Number  
MitreCaldera.Agents.links.jitter Number  
MitreCaldera.Agents.links.agent_reported_time String  
MitreCaldera.Agents.links.deadman Boolean  
MitreCaldera.Agents.links.used.unique String  
MitreCaldera.Agents.links.used.name String  
MitreCaldera.Agents.links.used.created String  
MitreCaldera.Agents.links.used.limit_count Number  
MitreCaldera.Agents.links.used.technique_id String  
MitreCaldera.Agents.links.used.trait String  
MitreCaldera.Agents.links.used.source String  
MitreCaldera.Agents.links.used.score Number  
MitreCaldera.Agents.links.host String  
MitreCaldera.Agents.links.status Number  
MitreCaldera.Agents.links.score Number  
MitreCaldera.Agents.links.command String  
MitreCaldera.Agents.links.unique String  
MitreCaldera.Agents.links.cleanup Number  
MitreCaldera.Agents.links.decide String  
MitreCaldera.Agents.links.facts.unique String  
MitreCaldera.Agents.links.facts.name String  
MitreCaldera.Agents.links.facts.created String  
MitreCaldera.Agents.links.facts.limit_count Number  
MitreCaldera.Agents.links.facts.technique_id String  
MitreCaldera.Agents.links.facts.trait String  
MitreCaldera.Agents.links.facts.source String  
MitreCaldera.Agents.links.facts.score Number  
MitreCaldera.Agents.links.paw String  
MitreCaldera.Agents.links.output String  
MitreCaldera.Agents.deadman_enabled Boolean  
MitreCaldera.Agents.ppid Number  
MitreCaldera.Agents.pid Number  
MitreCaldera.Agents.created String  
MitreCaldera.Agents.origin_link_id String  
MitreCaldera.Agents.last_seen String  
MitreCaldera.Agents.platform String  
MitreCaldera.Agents.pending_contact String  
MitreCaldera.Agents.host String  
MitreCaldera.Agents.group String  
MitreCaldera.Agents.location String  
MitreCaldera.Agents.display_name String  
MitreCaldera.Agents.upstream_dest String  
MitreCaldera.Agents.sleep_max Number  
MitreCaldera.Agents.architecture String  
MitreCaldera.Agents.sleep_min Number  
MitreCaldera.Agents.server String  
MitreCaldera.Agents.contact String  
MitreCaldera.Agents.privilege String  
MitreCaldera.Agents.username String  
MitreCaldera.Agents.trusted Boolean  
MitreCaldera.Agents.proxy_chain String  
MitreCaldera.Agents.paw String  
MitreCaldera.Agents.exe_name String  

caldera-get-config

Retrieve Config

Base Command

caldera-get-config

Input

Argument Name Description Required
name Name of the configuration file to be retrieved (example: main). Default is main. Required

Context Output

Path Type Description
MitreCaldera.Name String Config name
MitreCaldera.Config Unknown Config settings

caldera-get-contacts

Retrieve a List of all available Contact reports

Base Command

caldera-get-contacts

Input

Argument Name Description Required
name Optional name of the contact to get beacons for, e.g. HTTP, TCP, et cetera. Optional

Context Output

Path Type Description
MitreCaldera.Contacts Unknnown List of contacts

caldera-get-deploy-commands

Retrieve deploy commands with optional Ability ID

Base Command

caldera-get-deploy-commands

Input

Argument Name Description Required
ability_id ID of the ability to retrieve deploy commands for. Optional

Context Output

Path Type Description
MitreCaldera.DeployCommands.command String Command
MitreCaldera.DeployCommands.description String Description
MitreCaldera.DeployCommands.executor String Executor
MitreCaldera.DeployCommands.name String Name
MitreCaldera.DeployCommands.platform String Platform
MitreCaldera.DeployCommands.variations.command String Command
MitreCaldera.DeployCommands.variations.description String Description

caldera-get-facts

Retrieve Facts with optional Operation ID

Base Command

caldera-get-facts

Input

Argument Name Description Required
sort . Optional
include . Optional
exclude . Optional
operation_id Optional Operation ID. Optional

Context Output

Path Type Description
MitreCaldera.Facts.unique String  
MitreCaldera.Facts.name String  
MitreCaldera.Facts.created String  
MitreCaldera.Facts.limit_count Number  
MitreCaldera.Facts.technique_id String  
MitreCaldera.Facts.trait String  
MitreCaldera.Facts.source String  
MitreCaldera.Facts.score Number  

caldera-get-health

Health endpoints returns the status of CALDERA

Base Command

caldera-get-health

Input

There are no input arguments for this command.

Context Output

Path Type Description
MitreCaldera.CalderaInfo.application String  
MitreCaldera.CalderaInfo.version String  
MitreCaldera.CalderaInfo.plugins.name String  
MitreCaldera.CalderaInfo.plugins.enabled Boolean  
MitreCaldera.CalderaInfo.plugins.description String  
MitreCaldera.CalderaInfo.plugins.address String  

caldera-get-obfuscators

Retrieve obfuscators with optional name

Base Command

caldera-get-obfuscators

Input

Argument Name Description Required
name Name of the Obfuscator. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Obfuscators.name String  
MitreCaldera.Obfuscators.module String  
MitreCaldera.Obfuscators.description String  

caldera-get-objectives

Retrieve objectives with optional Objective ID

Base Command

caldera-get-objectives

Input

Argument Name Description Required
id Optional UUID of the objective to be retrieved. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Objectives.name String  
MitreCaldera.Objectives.id String  
MitreCaldera.Objectives.percentage Unknown  
MitreCaldera.Objectives.goals.count Number  
MitreCaldera.Objectives.goals.achieved Boolean  
MitreCaldera.Objectives.goals.operator String  
MitreCaldera.Objectives.goals.value String  
MitreCaldera.Objectives.goals.target String  
MitreCaldera.Objectives.description String  

caldera-get-operations

Retrieve operations

Base Command

caldera-get-operations

Input

Argument Name Description Required
id Optional UUID of the Operation object to be retrieved. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Operations.name String  
MitreCaldera.Operations.autonomous Number  
MitreCaldera.Operations.id String  
MitreCaldera.Operations.visibility Number  
MitreCaldera.Operations.state String  
MitreCaldera.Operations.group String  
MitreCaldera.Operations.host_group.watchdog Number  
MitreCaldera.Operations.host_group.links.relationships.unique String  
MitreCaldera.Operations.host_group.links.relationships.origin String  
MitreCaldera.Operations.host_group.links.relationships.edge String  
MitreCaldera.Operations.host_group.links.relationships.score Number  
MitreCaldera.Operations.host_group.links.id String  
MitreCaldera.Operations.host_group.links.collect String  
MitreCaldera.Operations.host_group.links.pid String  
MitreCaldera.Operations.host_group.links.finish String  
MitreCaldera.Operations.host_group.links.pin Number  
MitreCaldera.Operations.host_group.links.jitter Number  
MitreCaldera.Operations.host_group.links.agent_reported_time String  
MitreCaldera.Operations.host_group.links.deadman Boolean  
MitreCaldera.Operations.host_group.links.used.unique String  
MitreCaldera.Operations.host_group.links.used.name String  
MitreCaldera.Operations.host_group.links.used.created String  
MitreCaldera.Operations.host_group.links.used.limit_count Number  
MitreCaldera.Operations.host_group.links.used.technique_id String  
MitreCaldera.Operations.host_group.links.used.trait String  
MitreCaldera.Operations.host_group.links.used.source String  
MitreCaldera.Operations.host_group.links.used.score Number  
MitreCaldera.Operations.host_group.links.host String  
MitreCaldera.Operations.host_group.links.status Number  
MitreCaldera.Operations.host_group.links.score Number  
MitreCaldera.Operations.host_group.links.command String  
MitreCaldera.Operations.host_group.links.unique String  
MitreCaldera.Operations.host_group.links.cleanup Number  
MitreCaldera.Operations.host_group.links.decide String  
MitreCaldera.Operations.host_group.links.facts.unique String  
MitreCaldera.Operations.host_group.links.facts.name String  
MitreCaldera.Operations.host_group.links.facts.created String  
MitreCaldera.Operations.host_group.links.facts.limit_count Number  
MitreCaldera.Operations.host_group.links.facts.technique_id String  
MitreCaldera.Operations.host_group.links.facts.trait String  
MitreCaldera.Operations.host_group.links.facts.source String  
MitreCaldera.Operations.host_group.links.facts.score Number  
MitreCaldera.Operations.host_group.links.paw String  
MitreCaldera.Operations.host_group.links.output String  
MitreCaldera.Operations.host_group.deadman_enabled Boolean  
MitreCaldera.Operations.host_group.ppid Number  
MitreCaldera.Operations.host_group.pid Number  
MitreCaldera.Operations.host_group.created String  
MitreCaldera.Operations.host_group.origin_link_id String  
MitreCaldera.Operations.host_group.last_seen String  
MitreCaldera.Operations.host_group.platform String  
MitreCaldera.Operations.host_group.pending_contact String  
MitreCaldera.Operations.host_group.host String  
MitreCaldera.Operations.host_group.group String  
MitreCaldera.Operations.host_group.location String  
MitreCaldera.Operations.host_group.display_name String  
MitreCaldera.Operations.host_group.upstream_dest String  
MitreCaldera.Operations.host_group.sleep_max Number  
MitreCaldera.Operations.host_group.architecture String  
MitreCaldera.Operations.host_group.sleep_min Number  
MitreCaldera.Operations.host_group.server String  
MitreCaldera.Operations.host_group.contact String  
MitreCaldera.Operations.host_group.privilege String  
MitreCaldera.Operations.host_group.username String  
MitreCaldera.Operations.host_group.trusted Boolean  
MitreCaldera.Operations.host_group.proxy_chain String  
MitreCaldera.Operations.host_group.paw String  
MitreCaldera.Operations.host_group.exe_name String  
MitreCaldera.Operations.obfuscator String  
MitreCaldera.Operations.use_learning_parsers Boolean  
MitreCaldera.Operations.jitter String  
MitreCaldera.Operations.start String  
MitreCaldera.Operations.auto_close Boolean  

caldera-get-operation-links

Get Links from Operation with optional Link ID

Base Command

caldera-get-operation-links

Input

Argument Name Description Required
operation_id . Required
link_id Optional UUID of the Link with the operation. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.OperationLinks.relationships.unique String  
MitreCaldera.OperationLinks.relationships.origin String  
MitreCaldera.OperationLinks.relationships.edge String  
MitreCaldera.OperationLinks.relationships.score Number  
MitreCaldera.OperationLinks.id String  
MitreCaldera.OperationLinks.collect String  
MitreCaldera.OperationLinks.pid String  
MitreCaldera.OperationLinks.finish String  
MitreCaldera.OperationLinks.pin Number  
MitreCaldera.OperationLinks.jitter Number  
MitreCaldera.OperationLinks.agent_reported_time String  
MitreCaldera.OperationLinks.deadman Boolean  
MitreCaldera.OperationLinks.used.unique String  
MitreCaldera.OperationLinks.used.name String  
MitreCaldera.OperationLinks.used.created String  
MitreCaldera.OperationLinks.used.limit_count Number  
MitreCaldera.OperationLinks.used.technique_id String  
MitreCaldera.OperationLinks.used.trait String  
MitreCaldera.OperationLinks.used.source String  
MitreCaldera.OperationLinks.used.score Number  
MitreCaldera.OperationLinks.host String  
MitreCaldera.OperationLinks.status Number  
MitreCaldera.OperationLinks.score Number  
MitreCaldera.OperationLinks.command String  
MitreCaldera.OperationLinks.unique String  
MitreCaldera.OperationLinks.cleanup Number  
MitreCaldera.OperationLinks.decide String  
MitreCaldera.OperationLinks.facts.unique String  
MitreCaldera.OperationLinks.facts.name String  
MitreCaldera.OperationLinks.facts.created String  
MitreCaldera.OperationLinks.facts.limit_count Number  
MitreCaldera.OperationLinks.facts.technique_id String  
MitreCaldera.OperationLinks.facts.trait String  
MitreCaldera.OperationLinks.facts.source String  
MitreCaldera.OperationLinks.facts.score Number  
MitreCaldera.OperationLinks.paw String  
MitreCaldera.OperationLinks.output String  

caldera-get-operation-links-result

Retrieve the result of a link

Base Command

caldera-get-operation-links-result

Input

Argument Name Description Required
operation_id UUID of the operation object to be retrieved. Required
link_id UUID of the link object to retrieve results of. Required
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.OperationLinks.relationships.unique String  
MitreCaldera.OperationLinks.relationships.origin String  
MitreCaldera.OperationLinks.relationships.edge String  
MitreCaldera.OperationLinks.relationships.score Number  
MitreCaldera.OperationLinks.id String  
MitreCaldera.OperationLinks.collect String  
MitreCaldera.OperationLinks.pid String  
MitreCaldera.OperationLinks.finish String  
MitreCaldera.OperationLinks.pin Number  
MitreCaldera.OperationLinks.jitter Number  
MitreCaldera.OperationLinks.agent_reported_time String  
MitreCaldera.OperationLinks.deadman Boolean  
MitreCaldera.OperationLinks.used.unique String  
MitreCaldera.OperationLinks.used.name String  
MitreCaldera.OperationLinks.used.created String  
MitreCaldera.OperationLinks.used.limit_count Number  
MitreCaldera.OperationLinks.used.technique_id String  
MitreCaldera.OperationLinks.used.trait String  
MitreCaldera.OperationLinks.used.source String  
MitreCaldera.OperationLinks.used.score Number  
MitreCaldera.OperationLinks.host String  
MitreCaldera.OperationLinks.status Number  
MitreCaldera.OperationLinks.score Number  
MitreCaldera.OperationLinks.command String  
MitreCaldera.OperationLinks.unique String  
MitreCaldera.OperationLinks.cleanup Number  
MitreCaldera.OperationLinks.decide String  
MitreCaldera.OperationLinks.facts.unique String  
MitreCaldera.OperationLinks.facts.name String  
MitreCaldera.OperationLinks.facts.created String  
MitreCaldera.OperationLinks.facts.limit_count Number  
MitreCaldera.OperationLinks.facts.technique_id String  
MitreCaldera.OperationLinks.facts.trait String  
MitreCaldera.OperationLinks.facts.source String  
MitreCaldera.OperationLinks.facts.score Number  
MitreCaldera.OperationLinks.paw String  
MitreCaldera.OperationLinks.output String  

caldera-get-operations-potential-links

Retrieve potential links for an operation with optional PAW.

Base Command

caldera-get-operations-potential-links

Input

Argument Name Description Required
operation_id UUID of the operation object to retrieve links for. Required
paw Optional Agent paw for the specified operation. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.OperationLinks.relationships.unique String  
MitreCaldera.OperationLinks.relationships.origin String  
MitreCaldera.OperationLinks.relationships.edge String  
MitreCaldera.OperationLinks.relationships.score Number  
MitreCaldera.OperationLinks.id String  
MitreCaldera.OperationLinks.collect String  
MitreCaldera.OperationLinks.pid String  
MitreCaldera.OperationLinks.finish String  
MitreCaldera.OperationLinks.pin Number  
MitreCaldera.OperationLinks.jitter Number  
MitreCaldera.OperationLinks.agent_reported_time String  
MitreCaldera.OperationLinks.deadman Boolean  
MitreCaldera.OperationLinks.used.unique String  
MitreCaldera.OperationLinks.used.name String  
MitreCaldera.OperationLinks.used.created String  
MitreCaldera.OperationLinks.used.limit_count Number  
MitreCaldera.OperationLinks.used.technique_id String  
MitreCaldera.OperationLinks.used.trait String  
MitreCaldera.OperationLinks.used.source String  
MitreCaldera.OperationLinks.used.score Number  
MitreCaldera.OperationLinks.host String  
MitreCaldera.OperationLinks.status Number  
MitreCaldera.OperationLinks.score Number  
MitreCaldera.OperationLinks.command String  
MitreCaldera.OperationLinks.unique String  
MitreCaldera.OperationLinks.cleanup Number  
MitreCaldera.OperationLinks.decide String  
MitreCaldera.OperationLinks.facts.unique String  
MitreCaldera.OperationLinks.facts.name String  
MitreCaldera.OperationLinks.facts.created String  
MitreCaldera.OperationLinks.facts.limit_count Number  
MitreCaldera.OperationLinks.facts.technique_id String  
MitreCaldera.OperationLinks.facts.trait String  
MitreCaldera.OperationLinks.facts.source String  
MitreCaldera.OperationLinks.facts.score Number  
MitreCaldera.OperationLinks.paw String  
MitreCaldera.OperationLinks.output String  

caldera-get-planners

Retrieve planners with optional Planner ID

Base Command

caldera-get-planners

Input

Argument Name Description Required
planner_id UUID of the Planner object to be retrieved. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Planners.name String  
MitreCaldera.Planners.allow_repeatable_abilities Boolean  
MitreCaldera.Planners.stopping_conditions.unique String  
MitreCaldera.Planners.stopping_conditions.name String  
MitreCaldera.Planners.stopping_conditions.created String  
MitreCaldera.Planners.stopping_conditions.limit_count Number  
MitreCaldera.Planners.stopping_conditions.technique_id String  
MitreCaldera.Planners.stopping_conditions.trait String  
MitreCaldera.Planners.stopping_conditions.source String  
MitreCaldera.Planners.stopping_conditions.score Number  
MitreCaldera.Planners.id String  
MitreCaldera.Planners.plugin String  
MitreCaldera.Planners.module String  
MitreCaldera.Planners.description String  

caldera-get-plugins

Retrieve plugins with optional Name

Base Command

caldera-get-plugins

Input

Argument Name Description Required
name The name of the plugin. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Plugins.name String  
MitreCaldera.Plugins.enabled Boolean  
MitreCaldera.Plugins.address String  
MitreCaldera.Plugins.access Number  
MitreCaldera.Plugins.data_dir String  
MitreCaldera.Plugins.description String  

caldera-get-relationships

Retrieve Relationships with optional Operation ID

Base Command

caldera-get-relationships

Input

Argument Name Description Required
operation_id . Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Relationships.unique String  
MitreCaldera.Relationships.origin String  
MitreCaldera.Relationships.edge String  
MitreCaldera.Relationships.score Number  

caldera-get-schedules

Retrieve Schedules with optional Schedule ID

Base Command

caldera-get-schedules

Input

Argument Name Description Required
schedule_id Optional UUID of the Schedule to be retrieved. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Schedules.schedule String  
MitreCaldera.Schedules.id String  

caldera-get-sources

Retrieve all Fact Sources with optional Fact Source ID

Base Command

caldera-get-sources

Input

Argument Name Description Required
source_id The id of the Fact Source. Optional
sort . Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Sources.name String  
MitreCaldera.Sources.adjustments.ability_id String  
MitreCaldera.Sources.adjustments.offset Number  
MitreCaldera.Sources.adjustments.trait String  
MitreCaldera.Sources.adjustments.value String  
MitreCaldera.Sources.relationships.unique String  
MitreCaldera.Sources.relationships.origin String  
MitreCaldera.Sources.relationships.edge String  
MitreCaldera.Sources.relationships.score Number  
MitreCaldera.Sources.id String  
MitreCaldera.Sources.rules.trait String  
MitreCaldera.Sources.rules.match String  
MitreCaldera.Sources.facts.unique String  
MitreCaldera.Sources.facts.name String  
MitreCaldera.Sources.facts.created String  
MitreCaldera.Sources.facts.limit_count Number  
MitreCaldera.Sources.facts.technique_id String  
MitreCaldera.Sources.facts.trait String  
MitreCaldera.Sources.facts.source String  
MitreCaldera.Sources.facts.score Number  
MitreCaldera.Sources.plugin String  

caldera-get-operation-event-logs

Get Operation Event Logs

Base Command

caldera-get-operation-event-logs

Input

Argument Name Description Required
operation_id . Required
enable_agent_output Whether to enable the agent output. Possible values are: false, true. Default is false. Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Operations.EventLogs.id String  
MitreCaldera.Operations.EventLogs.collected_timestamp String  
MitreCaldera.Operations.EventLogs.ability_metadata Unknown  
MitreCaldera.Operations.EventLogs.attack_metadata Unknown  
MitreCaldera.Operations.EventLogs.operation_metadata Unknown  
MitreCaldera.Operations.EventLogs.finished_timestamp String  
MitreCaldera.Operations.EventLogs.agent_metadata Unknown  
MitreCaldera.Operations.EventLogs.pid Number  
MitreCaldera.Operations.EventLogs.command String  
MitreCaldera.Operations.EventLogs.status Number  
MitreCaldera.Operations.EventLogs.platform String  
MitreCaldera.Operations.EventLogs.executor String  
MitreCaldera.Operations.EventLogs.delegated_timestamp String  

caldera-get-operation-report

Get Operation Report

Base Command

caldera-get-operation-report

Input

Argument Name Description Required
operation_id . Required
enable_agent_output Whether to enable the agent output. Possible values are: false, true. Default is false. Optional
include . Optional
exclude . Optional

Context Output

Path Type Description
MitreCaldera.Operations.OperationReport.id String  
MitreCaldera.Operations.OperationReport.start String  
MitreCaldera.Operations.OperationReport.steps Unknown  
MitreCaldera.Operations.OperationReport.facts Unknown  
MitreCaldera.Operations.OperationReport.host_group Unknown  
MitreCaldera.Operations.OperationReport.name String  
MitreCaldera.Operations.OperationReport.jitter String  
MitreCaldera.Operations.OperationReport.planner String  
MitreCaldera.Operations.OperationReport.finish String  
MitreCaldera.Operations.OperationReport.adversary Unknown  
MitreCaldera.Operations.OperationReport.skipped_abilities Unknown  
MitreCaldera.Operations.OperationReport.objectives Unknown  

caldera-replace-ability

Replaces an existing ability.

Base Command

caldera-replace-ability

Input

Argument Name Description Required
ability_id UUID of the Ability to be retrieved. Required
ability_name . Optional
ability_buckets . Optional
ability_technique_id . Optional
ability_delete_payload . Optional
ability_executors . Optional
ability_privilege . Optional
ability_requirements . Optional
ability_plugin . Optional
ability_access . Optional
ability_tactic . Optional
ability_additional_info . Optional
ability_singleton . Optional
ability_technique_name . Optional
ability_repeatable . Optional
ability_description . Optional

Context Output

Path Type Description
MitreCaldera.Abilities.id String  
MitreCaldera.Abilities.name String  
MitreCaldera.Abilities.technique_id String  
MitreCaldera.Abilities.delete_payload Boolean  
MitreCaldera.Abilities.executors.name String  
MitreCaldera.Abilities.executors.platform String  
MitreCaldera.Abilities.executors.language String  
MitreCaldera.Abilities.executors.variations.command String  
MitreCaldera.Abilities.executors.variations.description String  
MitreCaldera.Abilities.executors.build_target String  
MitreCaldera.Abilities.executors.timeout Number  
MitreCaldera.Abilities.executors.parsers.module String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.edge String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.source String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.target String  
MitreCaldera.Abilities.executors.command String  
MitreCaldera.Abilities.executors.code String  
MitreCaldera.Abilities.privilege String  
MitreCaldera.Abilities.requirements.module String  
MitreCaldera.Abilities.plugin String  
MitreCaldera.Abilities.tactic String  
MitreCaldera.Abilities.singleton Boolean  
MitreCaldera.Abilities.technique_name String  
MitreCaldera.Abilities.repeatable Boolean  
MitreCaldera.Abilities.description String  

caldera-replace-schedule

Replace Schedule

Base Command

caldera-replace-schedule

Input

Argument Name Description Required
schedule_id UUID of the Schedule to be replaced. Required
partial_schedule_schedule . Optional
partial_schedule_task_name partial_schedule_task name. Optional
partial_schedule_task_autonomous partial_schedule_task autonomous. Optional
partial_schedule_task_id partial_schedule_task id. Optional
partial_schedule_task_objective partial_schedule_task objective. Optional
partial_schedule_task_visibility partial_schedule_task visibility. Optional
partial_schedule_task_state partial_schedule_task state. Optional
partial_schedule_task_group partial_schedule_task group. Optional
partial_schedule_task_host_group partial_schedule_task host_group. Optional
partial_schedule_task_planner partial_schedule_task planner. Optional
partial_schedule_task_obfuscator partial_schedule_task obfuscator. Optional
partial_schedule_task_chain partial_schedule_task chain. Optional
partial_schedule_task_use_learning_parsers partial_schedule_task use_learning_parsers. Optional
partial_schedule_task_source partial_schedule_task source. Optional
partial_schedule_task_jitter partial_schedule_task jitter. Optional
partial_schedule_task_start partial_schedule_task start. Optional
partial_schedule_task_adversary partial_schedule_task adversary. Optional
partial_schedule_task_auto_close partial_schedule_task auto_close. Optional

Context Output

Path Type Description
MitreCaldera.Schedules.schedule String  
MitreCaldera.Schedules.id String  

caldera-update-agent-config

Update Agent Config

Base Command

caldera-update-agent-config

Input

Argument Name Description Required
watchdog . Optional
sleep_min . Optional
deployments . Optional
deadman_abilities . Optional
untrusted_timer . Optional
bootstrap_abilities . Optional
sleep_max . Optional
implant_name . Optional

Context Output

Path Type Description
MitreCaldera.AgentConfig.watchdog Number  
MitreCaldera.AgentConfig.sleep_min Number  
MitreCaldera.AgentConfig.untrusted_timer Number  
MitreCaldera.AgentConfig.sleep_max Number  
MitreCaldera.AgentConfig.implant_name String  

caldera-update-adversary

Update an adversary

Base Command

caldera-update-adversary

Input

Argument Name Description Required
adversary_id UUID of the adversary to be updated. Required
adversaryname . Optional
adversarytags . Optional
adversaryobjective . Optional
adversaryhas_repeatable_abilities . Optional
adversaryatomic_ordering . Optional
adversaryplugin . Optional
adversarydescription . Optional

Context Output

Path Type Description
MitreCaldera.Adversaries.name String  
MitreCaldera.Adversaries.objective String  
MitreCaldera.Adversaries.adversary_id String  
MitreCaldera.Adversaries.has_repeatable_abilities Boolean  
MitreCaldera.Adversaries.plugin String  
MitreCaldera.Adversaries.description String  

caldera-update-agent

Update an Agent

Base Command

caldera-update-agent

Input

Argument Name Description Required
paw ID of the Agent to update. Required
watchdog . Optional
sleep_min . Optional
trusted . Optional
sleep_max . Optional
pending_contact . Optional
group . Optional

Context Output

Path Type Description
MitreCaldera.Agents.watchdog Number  
MitreCaldera.Agents.links.relationships.unique String  
MitreCaldera.Agents.links.relationships.origin String  
MitreCaldera.Agents.links.relationships.edge String  
MitreCaldera.Agents.links.relationships.score Number  
MitreCaldera.Agents.links.id String  
MitreCaldera.Agents.links.collect String  
MitreCaldera.Agents.links.pid String  
MitreCaldera.Agents.links.finish String  
MitreCaldera.Agents.links.pin Number  
MitreCaldera.Agents.links.jitter Number  
MitreCaldera.Agents.links.agent_reported_time String  
MitreCaldera.Agents.links.deadman Boolean  
MitreCaldera.Agents.links.used.unique String  
MitreCaldera.Agents.links.used.name String  
MitreCaldera.Agents.links.used.created String  
MitreCaldera.Agents.links.used.limit_count Number  
MitreCaldera.Agents.links.used.technique_id String  
MitreCaldera.Agents.links.used.trait String  
MitreCaldera.Agents.links.used.source String  
MitreCaldera.Agents.links.used.score Number  
MitreCaldera.Agents.links.host String  
MitreCaldera.Agents.links.status Number  
MitreCaldera.Agents.links.score Number  
MitreCaldera.Agents.links.command String  
MitreCaldera.Agents.links.unique String  
MitreCaldera.Agents.links.cleanup Number  
MitreCaldera.Agents.links.decide String  
MitreCaldera.Agents.links.facts.unique String  
MitreCaldera.Agents.links.facts.name String  
MitreCaldera.Agents.links.facts.created String  
MitreCaldera.Agents.links.facts.limit_count Number  
MitreCaldera.Agents.links.facts.technique_id String  
MitreCaldera.Agents.links.facts.trait String  
MitreCaldera.Agents.links.facts.source String  
MitreCaldera.Agents.links.facts.score Number  
MitreCaldera.Agents.links.paw String  
MitreCaldera.Agents.links.output String  
MitreCaldera.Agents.deadman_enabled Boolean  
MitreCaldera.Agents.ppid Number  
MitreCaldera.Agents.pid Number  
MitreCaldera.Agents.created String  
MitreCaldera.Agents.origin_link_id String  
MitreCaldera.Agents.last_seen String  
MitreCaldera.Agents.platform String  
MitreCaldera.Agents.pending_contact String  
MitreCaldera.Agents.host String  
MitreCaldera.Agents.group String  
MitreCaldera.Agents.location String  
MitreCaldera.Agents.display_name String  
MitreCaldera.Agents.upstream_dest String  
MitreCaldera.Agents.sleep_max Number  
MitreCaldera.Agents.architecture String  
MitreCaldera.Agents.sleep_min Number  
MitreCaldera.Agents.server String  
MitreCaldera.Agents.contact String  
MitreCaldera.Agents.privilege String  
MitreCaldera.Agents.username String  
MitreCaldera.Agents.trusted Boolean  
MitreCaldera.Agents.proxy_chain String  
MitreCaldera.Agents.paw String  
MitreCaldera.Agents.exe_name String  

caldera-update-fact-source

Update an existing Fact Source.

Base Command

caldera-update-fact-source

Input

Argument Name Description Required
fact_source_id The id of the Fact Source. Required
source_name . Optional
source_adjustments . Optional
source_relationships . Optional
source_id . Optional
source_rules . Optional
source_facts . Optional
source_plugin . Optional

Context Output

Path Type Description
MitreCaldera.Sources.name String  
MitreCaldera.Sources.adjustments.ability_id String  
MitreCaldera.Sources.adjustments.offset Number  
MitreCaldera.Sources.adjustments.trait String  
MitreCaldera.Sources.adjustments.value String  
MitreCaldera.Sources.relationships.unique String  
MitreCaldera.Sources.relationships.origin String  
MitreCaldera.Sources.relationships.edge String  
MitreCaldera.Sources.relationships.score Number  
MitreCaldera.Sources.id String  
MitreCaldera.Sources.rules.trait String  
MitreCaldera.Sources.rules.match String  
MitreCaldera.Sources.facts.unique String  
MitreCaldera.Sources.facts.name String  
MitreCaldera.Sources.facts.created String  
MitreCaldera.Sources.facts.limit_count Number  
MitreCaldera.Sources.facts.technique_id String  
MitreCaldera.Sources.facts.trait String  
MitreCaldera.Sources.facts.source String  
MitreCaldera.Sources.facts.score Number  
MitreCaldera.Sources.plugin String  

caldera-update-objective

Update an objective

Base Command

caldera-update-objective

Input

Argument Name Description Required
objective_id UUID of the Objective to be updated. Required
name . Optional
goals . Optional
description . Optional

Context Output

Path Type Description
MitreCaldera.Objectives.name String  
MitreCaldera.Objectives.id String  
MitreCaldera.Objectives.percentage Unknown  
MitreCaldera.Objectives.goals.count Number  
MitreCaldera.Objectives.goals.achieved Boolean  
MitreCaldera.Objectives.goals.operator String  
MitreCaldera.Objectives.goals.value String  
MitreCaldera.Objectives.goals.target String  
MitreCaldera.Objectives.description String  

caldera-update-operation-fields

Update fields within an operation

Base Command

caldera-update-operation-fields

Input

Argument Name Description Required
operation_id UUID of the Operation object to be retrieved. Required
obfuscator . Optional
autonomous . Optional
state . Optional

Context Output

Path Type Description
MitreCaldera.Operations.name String  
MitreCaldera.Operations.autonomous Number  
MitreCaldera.Operations.id String  
MitreCaldera.Operations.visibility Number  
MitreCaldera.Operations.state String  
MitreCaldera.Operations.group String  
MitreCaldera.Operations.host_group.watchdog Number  
MitreCaldera.Operations.host_group.links.relationships.unique String  
MitreCaldera.Operations.host_group.links.relationships.origin String  
MitreCaldera.Operations.host_group.links.relationships.edge String  
MitreCaldera.Operations.host_group.links.relationships.score Number  
MitreCaldera.Operations.host_group.links.id String  
MitreCaldera.Operations.host_group.links.collect String  
MitreCaldera.Operations.host_group.links.pid String  
MitreCaldera.Operations.host_group.links.finish String  
MitreCaldera.Operations.host_group.links.pin Number  
MitreCaldera.Operations.host_group.links.jitter Number  
MitreCaldera.Operations.host_group.links.agent_reported_time String  
MitreCaldera.Operations.host_group.links.deadman Boolean  
MitreCaldera.Operations.host_group.links.used.unique String  
MitreCaldera.Operations.host_group.links.used.name String  
MitreCaldera.Operations.host_group.links.used.created String  
MitreCaldera.Operations.host_group.links.used.limit_count Number  
MitreCaldera.Operations.host_group.links.used.technique_id String  
MitreCaldera.Operations.host_group.links.used.trait String  
MitreCaldera.Operations.host_group.links.used.source String  
MitreCaldera.Operations.host_group.links.used.score Number  
MitreCaldera.Operations.host_group.links.host String  
MitreCaldera.Operations.host_group.links.status Number  
MitreCaldera.Operations.host_group.links.score Number  
MitreCaldera.Operations.host_group.links.command String  
MitreCaldera.Operations.host_group.links.unique String  
MitreCaldera.Operations.host_group.links.cleanup Number  
MitreCaldera.Operations.host_group.links.decide String  
MitreCaldera.Operations.host_group.links.facts.unique String  
MitreCaldera.Operations.host_group.links.facts.name String  
MitreCaldera.Operations.host_group.links.facts.created String  
MitreCaldera.Operations.host_group.links.facts.limit_count Number  
MitreCaldera.Operations.host_group.links.facts.technique_id String  
MitreCaldera.Operations.host_group.links.facts.trait String  
MitreCaldera.Operations.host_group.links.facts.source String  
MitreCaldera.Operations.host_group.links.facts.score Number  
MitreCaldera.Operations.host_group.links.paw String  
MitreCaldera.Operations.host_group.links.output String  
MitreCaldera.Operations.host_group.deadman_enabled Boolean  
MitreCaldera.Operations.host_group.ppid Number  
MitreCaldera.Operations.host_group.pid Number  
MitreCaldera.Operations.host_group.created String  
MitreCaldera.Operations.host_group.origin_link_id String  
MitreCaldera.Operations.host_group.last_seen String  
MitreCaldera.Operations.host_group.platform String  
MitreCaldera.Operations.host_group.pending_contact String  
MitreCaldera.Operations.host_group.host String  
MitreCaldera.Operations.host_group.group String  
MitreCaldera.Operations.host_group.location String  
MitreCaldera.Operations.host_group.display_name String  
MitreCaldera.Operations.host_group.upstream_dest String  
MitreCaldera.Operations.host_group.sleep_max Number  
MitreCaldera.Operations.host_group.architecture String  
MitreCaldera.Operations.host_group.sleep_min Number  
MitreCaldera.Operations.host_group.server String  
MitreCaldera.Operations.host_group.contact String  
MitreCaldera.Operations.host_group.privilege String  
MitreCaldera.Operations.host_group.username String  
MitreCaldera.Operations.host_group.trusted Boolean  
MitreCaldera.Operations.host_group.proxy_chain String  
MitreCaldera.Operations.host_group.paw String  
MitreCaldera.Operations.host_group.exe_name String  
MitreCaldera.Operations.obfuscator String  
MitreCaldera.Operations.use_learning_parsers Boolean  
MitreCaldera.Operations.jitter String  
MitreCaldera.Operations.start String  
MitreCaldera.Operations.auto_close Boolean  

caldera-update-main-config

Update Main Config

Base Command

caldera-update-main-config

Input

Argument Name Description Required
property . Required
value . Required

Context Output

There is no context output for this command.

caldera-update-facts

Update One or More Facts

Base Command

caldera-update-facts

Input

Argument Name Description Required
unique partial_factupdaterequest_updates unique. Optional
name partial_factupdaterequest_updates name. Optional
links partial_factupdaterequest_updates links. Optional
relationships partial_factupdaterequest_updates relationships. Optional
origin_type partial_factupdaterequest_updates origin_type. Optional
created partial_factupdaterequest_updates created. Optional
limit_count partial_factupdaterequest_updates limit_count. Optional
technique_id partial_factupdaterequest_updates technique_id. Optional
trait partial_factupdaterequest_updates trait. Optional
source partial_factupdaterequest_updates source. Optional
score partial_factupdaterequest_updates score. Optional
value partial_factupdaterequest_updates value. Optional
collected_by partial_factupdaterequest_updates collected_by. Optional
criteria_unique partial_factupdaterequest_criteria unique. Optional
criteria_name partial_factupdaterequest_criteria name. Optional
criteria_links partial_factupdaterequest_criteria links. Optional
criteria_relationships partial_factupdaterequest_criteria relationships. Optional
criteria_origin_type partial_factupdaterequest_criteria origin_type. Optional
criteria_created partial_factupdaterequest_criteria created. Optional
criteria_limit_count partial_factupdaterequest_criteria limit_count. Optional
criteria_technique_id partial_factupdaterequest_criteria technique_id. Optional
criteria_trait partial_factupdaterequest_criteria trait. Optional
criteria_source partial_factupdaterequest_criteria source. Optional
criteria_score partial_factupdaterequest_criteria score. Optional
criteria_value partial_factupdaterequest_criteria value. Optional
criteria_collected_by partial_factupdaterequest_criteria collected_by. Optional

Context Output

Path Type Description
MitreCaldera.Facts.unique String  
MitreCaldera.Facts.name String  
MitreCaldera.Facts.created String  
MitreCaldera.Facts.limit_count Number  
MitreCaldera.Facts.technique_id String  
MitreCaldera.Facts.trait String  
MitreCaldera.Facts.source String  
MitreCaldera.Facts.score Number  

caldera-update-relationships

Update One or More Relationships

Base Command

caldera-update-relationships

Input

Argument Name Description Required
unique partial_relationshipupdate_updates unique. Optional
origin partial_relationshipupdate_updates origin. Optional
edge partial_relationshipupdate_updates edge. Optional
source partial_relationshipupdate_updates source. Optional
score partial_relationshipupdate_updates score. Optional
target partial_relationshipupdate_updates target. Optional
criteria_unique partial_relationshipupdate_criteria unique. Optional
criteria_origin partial_relationshipupdate_criteria origin. Optional
criteria_edge partial_relationshipupdate_criteria edge. Optional
criteria_source partial_relationshipupdate_criteria source. Optional
criteria_score partial_relationshipupdate_criteria score. Optional
criteria_target partial_relationshipupdate_criteria target. Optional

Context Output

Path Type Description
MitreCaldera.Relationships.unique String  
MitreCaldera.Relationships.origin String  
MitreCaldera.Relationships.edge String  
MitreCaldera.Relationships.score Number  

caldera-update-ability

Updates an existing ability.

Base Command

caldera-update-ability

Input

Argument Name Description Required
ability_id UUID of the Ability to be retrieved. Required
name . Optional
buckets . Optional
technique_id . Optional
delete_payload . Optional
executors . Optional
privilege . Optional
technique_name . Optional
tactic . Optional
singleton . Optional
plugin . Optional
repeatable . Optional
description . Optional

Context Output

Path Type Description
MitreCaldera.Abilities.ability_id String  
MitreCaldera.Abilities.name String  
MitreCaldera.Abilities.technique_id String  
MitreCaldera.Abilities.delete_payload Boolean  
MitreCaldera.Abilities.executors.name String  
MitreCaldera.Abilities.executors.platform String  
MitreCaldera.Abilities.executors.language String  
MitreCaldera.Abilities.executors.variations.command String  
MitreCaldera.Abilities.executors.variations.description String  
MitreCaldera.Abilities.executors.build_target String  
MitreCaldera.Abilities.executors.timeout Number  
MitreCaldera.Abilities.executors.parsers.module String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.edge String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.source String  
MitreCaldera.Abilities.executors.parsers.parserconfigs.target String  
MitreCaldera.Abilities.executors.command String  
MitreCaldera.Abilities.executors.code String  
MitreCaldera.Abilities.privilege String  
MitreCaldera.Abilities.requirements.module String  
MitreCaldera.Abilities.plugin String  
MitreCaldera.Abilities.tactic String  
MitreCaldera.Abilities.singleton Boolean  
MitreCaldera.Abilities.technique_name String  
MitreCaldera.Abilities.repeatable Boolean  
MitreCaldera.Abilities.description String  

caldera-update-schedule

Update Schedule

Base Command

caldera-update-schedule

Input

Argument Name Description Required
schedule_id UUID of the Schedule to be updated. Required
schedule . Optional
task_obfuscator task obfuscator. Optional
task_autonomous task autonomous. Optional
task_state task state. Optional

Context Output

Path Type Description
MitreCaldera.Schedules.schedule String  
MitreCaldera.Schedules.id String  

caldera-update-operation-link

Update the specified link within an operation

Base Command

caldera-update-operation-link

Input

Argument Name Description Required
operation_id String UUID of the Operation containing desired link. Required
link_id String UUID of the Link with the above operation. Required
command . Optional
status . Optional

Context Output

Path Type Description
MitreCaldera.Links.relationships.unique String  
MitreCaldera.Links.relationships.origin String  
MitreCaldera.Links.relationships.edge String  
MitreCaldera.Links.relationships.score Number  
MitreCaldera.Links.id String  
MitreCaldera.Links.collect String  
MitreCaldera.Links.pid String  
MitreCaldera.Links.finish String  
MitreCaldera.Links.pin Number  
MitreCaldera.Links.jitter Number  
MitreCaldera.Links.agent_reported_time String  
MitreCaldera.Links.deadman Boolean  
MitreCaldera.Links.used.unique String  
MitreCaldera.Links.used.name String  
MitreCaldera.Links.used.created String  
MitreCaldera.Links.used.limit_count Number  
MitreCaldera.Links.used.technique_id String  
MitreCaldera.Links.used.trait String  
MitreCaldera.Links.used.source String  
MitreCaldera.Links.used.score Number  
MitreCaldera.Links.host String  
MitreCaldera.Links.status Number  
MitreCaldera.Links.score Number  
MitreCaldera.Links.command String  
MitreCaldera.Links.unique String  
MitreCaldera.Links.cleanup Number  
MitreCaldera.Links.decide String  
MitreCaldera.Links.facts.unique String  
MitreCaldera.Links.facts.name String  
MitreCaldera.Links.facts.created String  
MitreCaldera.Links.facts.limit_count Number  
MitreCaldera.Links.facts.technique_id String  
MitreCaldera.Links.facts.trait String  
MitreCaldera.Links.facts.source String  
MitreCaldera.Links.facts.score Number  
MitreCaldera.Links.paw String  
MitreCaldera.Links.output String  

Configuration parameters

  • url — Server URL (e.g. https://www.example.com:8888) (required)
  • api_key — API Key (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings
  • isFetch — Fetch incidents
  • incidentFetchInterval — Incidents Fetch Interval
  • incidentType — Incident type
  • client_name — Filter name
  • first_fetch — First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  • max_fetch — Maximum number of incidents per fetch

Commands (53)

  • caldera-create-ability

    Creates a new ability.

  • caldera-create-adversary

    Create a new adversary.

  • caldera-create-agent

    Create a new agent.

  • caldera-create-fact

    Create a Fact.

  • caldera-create-fact-source

    Create a Fact Source.

  • caldera-create-objective

    Create a new objective.

  • caldera-create-operation

    Create a new CALDERA operation record.

  • caldera-create-potential-link

    Creates a potential Link.

  • caldera-create-relationship

    Create a Relationship.

  • caldera-create-schedule

    Create Schedule.

  • caldera-delete-ability

    Deletes an ability.

  • caldera-delete-adversary

    Deletes an adversary.

  • caldera-delete-agent

    Delete an Agent.

  • caldera-delete-fact-source

    Delete an existing Fact Source.

  • caldera-delete-facts

    Delete One or More Facts.

  • caldera-delete-operation

    Delete an operation by operation id.

  • caldera-delete-relationships

    Delete One or More Relationships.

  • caldera-delete-schedule

    Delete Schedule.

  • caldera-get-abilities

    Get all Abilities with optional ability ID.

  • caldera-get-adversaries

    Get all Adversaries with optional Adversary ID.

  • caldera-get-agents

    Retrieves all agents with optional Agent PAW.

  • caldera-get-config

    Retrieve Config.

  • caldera-get-contacts

    Retrieve a List of all available Contact reports.

  • caldera-get-deploy-commands

    Retrieve deploy commands with optional Ability ID.

  • caldera-get-facts

    Retrieve Facts with optional Operation ID.

  • caldera-get-health

    Health endpoints returns the status of CALDERA.

  • caldera-get-obfuscators

    Retrieve obfuscators with optional name.

  • caldera-get-objectives

    Retrieve objectives with optional Objective ID.

  • caldera-get-operation-event-logs

    Get Operation Event Logs.

  • caldera-get-operation-links

    Get Links from Operation with optional Link ID.

  • caldera-get-operation-links-result

    Retrieve the result of a link.

  • caldera-get-operation-report

    Get Operation Report.

  • caldera-get-operations

    Retrieve operations.

  • caldera-get-operations-potential-links

    Retrieve potential links for an operation with optional PAW.

  • caldera-get-planners

    Retrieve planners with optional Planner ID.

  • caldera-get-plugins

    Retrieve plugins with optional Name.

  • caldera-get-relationships

    Retrieve Relationships with optional Operation ID.

  • caldera-get-schedules

    Retrieve Schedules with optional Schedule ID.

  • caldera-get-sources

    Retrieve all Fact Sources with optional Fact Source ID.

  • caldera-replace-ability

    Replaces an existing ability.

  • caldera-replace-schedule

    Replace Schedule.

  • caldera-update-ability

    Updates an existing ability.

  • caldera-update-adversary

    Update an adversary.

  • caldera-update-agent

    Update an Agent.

  • caldera-update-agent-config

    Update Agent Config.

  • caldera-update-fact-source

    Update an existing Fact Source.

  • caldera-update-facts

    Update One or More Facts.

  • caldera-update-main-config

    Update Main Config.

  • caldera-update-objective

    Update an objective.

  • caldera-update-operation-fields

    Update fields within an operation.

  • caldera-update-operation-link

    Update the specified link within an operation.

  • caldera-update-relationships

    Update One or More Relationships.

  • caldera-update-schedule

    Update Schedule.

Source

MitreCaldera.py MitreCaldera.yml MitreCaldera_description.md command_examples.txt
Download History Raw 
commonfields:
  id: MitreCaldera
  version: -1
sectionorder:
- Connect
- Collect
name: MitreCaldera
display: MitreCaldera
category: IT Services
provider: MITRE Corporation
description: Mitre Caldera can be used to test endpoint security solutions and assess a network's security posture against the common post-compromise adversarial techniques contained in the ATT&CK model. CALDERA leverages the ATT&CK model to identify and replicate adversary behaviors as if a real intrusion is occurring.
configuration:
- name: url
  display: Server URL (e.g. https://www.example.com:8888)
  defaultvalue: https://www.example.com:8888
  type: 0
  required: true
- name: api_key
  display: API Key
  defaultvalue: ''
  hiddenusername: true
  displaypassword: API Key
  type: 9
  required: true
- name: insecure
  display: Trust any certificate (not secure)
  defaultvalue: 'false'
  type: 8
  required: false
- name: proxy
  display: Use system proxy settings
  defaultvalue: 'false'
  type: 8
  required: false
- display: Fetch incidents
  name: isFetch
  type: 8
  required: false
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  defaultvalue: "1"
  type: 19
  required: false
- display: Incident type
  name: incidentType
  type: 13
  required: false
- display: Filter name
  name: client_name
  type: 0
  required: false
  additionalinfo: Fetch operations which contain this name.
- display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  defaultvalue: 7 days
  name: first_fetch
  type: 0
  required: false
- display: Maximum number of incidents per fetch
  additionalinfo: The maximum number of incidents per fetch. Cannot exceed 50.
  name: max_fetch
  type: 0
  defaultvalue: "50"
  required: false
script:
  script: ''
  type: python
  subtype: python3
  isfetch: true
  dockerimage: demisto/python3:3.12.8.3296088
  commands:
  - name: caldera-create-fact
    description: Create a Fact.
    arguments:
    - name: fact_name
      description: Fact name.
    - name: fact_links
      description: Fact links (CSV of IDs).
      isArray: true
    - name: fact_relationships
      description: Fact relationships (CSV of IDs).
      isArray: true
    - name: fact_origin_type
      description: Fact origin type.
    - name: fact_limit_count
      description: Fact limit count.
    - name: fact_technique_id
      description: Fact technique ID.
    - name: fact_trait
      description: Fact trait.
      required: true
    - name: fact_source
      description: Fact source.
    - name: fact_score
      description: Fact score.
    - name: fact_value
      description: Fact value.
    outputs:
    - type: String
      contextPath: MitreCaldera.Facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.score
      description: ''
  - name: caldera-create-fact-source
    description: Create a Fact Source.
    arguments:
    - name: name
      description: Name.
    - name: adjustments
      description: Adjustments (array of adjustment objects).
      isArray: true
    - name: relationships
      description: Relationships (array of relationship objects).
      isArray: true
    - name: rules
      description: Rules (array of rule objects).
      isArray: true
    - name: facts
      description: Facts (array of fact objects).
      isArray: true
    - name: plugin
      description: Plugin.
    outputs:
    - type: String
      contextPath: MitreCaldera.Sources.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.ability_id
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.adjustments.offset
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.value
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.rules.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.rules.match
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.plugin
      description: ''
  - name: caldera-create-adversary
    description: Create a new adversary.
    arguments:
    - name: name
      description: Adversary name.
    - name: tags
      description: Tags (CSV of tag names).
      isArray: true
    - name: objective
      description: Objective.
    - name: atomic_ordering
      description: Atomic ordering (CSV of ability IDs).
      isArray: true
    - name: plugin
      description: Plugin.
    - name: description
      description: Description.
    outputs:
    - type: String
      contextPath: MitreCaldera.Adversaries.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.objective
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.adversary_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Adversaries.has_repeatable_abilities
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.description
      description: ''
  - name: caldera-create-agent
    description: Create a new agent.
    arguments:
    - name: watchdog
      description: Watchdog timer.
    - name: deadman_enabled
      description: Deadman enabled (true or false).
      auto: PREDEFINED
      predefined:
      - 'false'
      - 'true'
      defaultValue: 'false'
    - name: ppid
      description: PPID.
    - name: pid
      description: PID.
    - name: proxy_receivers
      description: Proxy Receivers (JSON dict).
    - name: origin_link_id
      description: Origin link ID.
    - name: available_contacts
      description: Available contacts (CSV of contact IDs).
      isArray: true
    - name: platform
      description: Platform.
    - name: host
      description: Host.
    - name: group
      description: Group.
    - name: location
      description: Location.
    - name: display_name
      description: Display name.
    - name: upstream_dest
      description: Upstream destination.
    - name: host_ip_addrs
      description: Host IP addresses (CSV of IP addresses).
      isArray: true
    - name: sleep_max
      description: Sleep maximum.
    - name: architecture
      description: Architecture.
    - name: sleep_min
      description: Sleep minimum.
    - name: server
      description: Server.
    - name: contact
      description: Contact.
    - name: exeutors
      description: Executors (CSV of executor IDs).
      isArray: true
    - name: privilege
      description: Privilege.
    - name: username
      description: Username.
    - name: trusted
      description: Trusted.
      auto: PREDEFINED
      predefined:
      - 'false'
      - 'true'
      defaultValue: 'true'
    - name: proxy_chain
      description: Proxy chain (array of proxy arrays).
      isArray: true
    - name: paw
      description: Agent PAW.
    - name: exe_name
      description: EXE name.
    outputs:
    - type: Number
      contextPath: MitreCaldera.Agents.watchdog
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.output
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.deadman_enabled
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.ppid
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.created
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.origin_link_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.last_seen
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.pending_contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.host
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.group
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.location
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.display_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.upstream_dest
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.architecture
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.sleep_min
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.server
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.username
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.trusted
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.proxy_chain
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.exe_name
      description: ''
  - name: caldera-create-operation
    description: Create a new CALDERA operation record.
    arguments:
    - name: name
      description: Operation name.
      required: true
    - name: autonomous
      description: Autonomous (autonomous or manual).
      auto: PREDEFINED
      predefined:
      - autonomous
      - manual
      defaultValue: autonomous
    - name: objective_id
      description: Objective ID.
    - name: visibility
      description: How visible should the operation be to the defense (1-100), default is 51.
    - name: state
      description: State.
      auto: PREDEFINED
      predefined:
      - running
      - paused
      - run_one_link
      defaultValue: running
    - name: group
      description: Group.
    - name: host_group
      description: Host group.
      isArray: true
    - name: planner_id
      description: Planner ID.
      required: true
    - name: obfuscator
      description: Obfuscator.
      auto: PREDEFINED
      predefined:
      - base64
      - base64jumble
      - base64noPadding
      - caesar cipher
      - plain-text
      - steganography
      defaultValue: plain-text
    - name: use_learning_parsers
      description: Use learning parsers.
      auto: PREDEFINED
      predefined:
      - 'false'
      - 'true'
      defaultValue: 'false'
    - name: source_id
      description: Source ID.
      required: true
    - name: jitter
      description: Jitter is defined as a fraction (default is "2/8").
    - name: adversary_id
      description: adversary id.
      required: true
    - name: auto_close
      description: Auto close.
      auto: PREDEFINED
      predefined:
      - 'false'
      - 'true'
      defaultValue: 'false'
    outputs:
    - type: String
      contextPath: MitreCaldera.Operations.name
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.autonomous
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.id
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.visibility
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.state
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.group
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.watchdog
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.output
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.deadman_enabled
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.ppid
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.created
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.origin_link_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.last_seen
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.pending_contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.host
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.group
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.location
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.display_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.upstream_dest
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.architecture
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.sleep_min
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.server
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.username
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.trusted
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.proxy_chain
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.exe_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.obfuscator
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.use_learning_parsers
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.start
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.auto_close
      description: ''
  - name: caldera-create-objective
    description: Create a new objective.
    arguments:
    - name: name
      description: Objective name.
    - name: goals
      description: Goals (array of objective objects).
      isArray: true
    - name: description
      description: Description.
    outputs:
    - type: String
      contextPath: MitreCaldera.Objectives.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.id
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Objectives.percentage
      description: ''
    - type: Number
      contextPath: MitreCaldera.Objectives.goals.count
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Objectives.goals.achieved
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.operator
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.value
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.description
      description: ''
  - name: caldera-create-relationship
    description: Create a Relationship.
    arguments:
    - name: relationship_unique
      description: ''
    - name: relationship_origin
      description: ''
    - name: relationship_edge
      description: ''
    - name: relationship_source_unique
      description: relationship_source unique.
    - name: relationship_source_name
      description: relationship_source name.
    - name: relationship_source_links
      description: relationship_source links.
    - name: relationship_source_relationships
      description: relationship_source relationships.
    - name: relationship_source_origin_type
      description: relationship_source origin_type.
    - name: relationship_source_created
      description: relationship_source created.
    - name: relationship_source_limit_count
      description: relationship_source limit_count.
    - name: relationship_source_technique_id
      description: relationship_source technique_id.
    - name: relationship_source_trait
      description: relationship_source trait.
      required: true
    - name: relationship_source_source
      description: relationship_source source.
    - name: relationship_source_score
      description: relationship_source score.
    - name: relationship_source_value
      description: relationship_source value.
    - name: relationship_source_collected_by
      description: relationship_source collected_by.
    - name: relationship_score
      description: ''
    - name: relationship_target
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Relationship.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationship.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationship.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Relationship.score
      description: ''
  - name: caldera-create-ability
    description: Creates a new ability.
    arguments:
    - name: ability_ability_id
      description: ''
    - name: ability_name
      description: ''
    - name: ability_buckets
      description: ''
      isArray: true
    - name: ability_technique_id
      description: ''
    - name: ability_delete_payload
      description: ''
    - name: ability_executors
      description: ''
      isArray: true
    - name: ability_privilege
      description: ''
    - name: ability_requirements
      description: ''
      isArray: true
    - name: ability_plugin
      description: ''
    - name: ability_access
      description: ''
    - name: ability_tactic
      description: ''
    - name: ability_additional_info
      description: ''
    - name: ability_singleton
      description: ''
    - name: ability_technique_name
      description: ''
    - name: ability_repeatable
      description: ''
    - name: ability_description
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Abilities.ability_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.delete_payload
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.language
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.description
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.build_target
      description: ''
    - type: Number
      contextPath: MitreCaldera.Abilities.executors.timeout
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.edge
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.source
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.code
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.requirements.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.tactic
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.singleton
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.repeatable
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.description
      description: ''
  - name: caldera-create-potential-link
    description: Creates a potential Link.
    arguments:
    - name: operation_id
      description: UUID of the operation object for the link to be created on.
      required: true
    - name: link_relationships
      description: ''
      isArray: true
    - name: link_id
      description: ''
    - name: link_collect
      description: ''
    - name: link_pid
      description: ''
    - name: link_visibility_adjustments
      description: link_visibility adjustments.
    - name: link_visibility_score
      description: link_visibility score.
    - name: link_finish
      description: ''
    - name: link_pin
      description: ''
    - name: link_jitter
      description: ''
    - name: link_agent_reported_time
      description: ''
    - name: link_deadman
      description: ''
    - name: link_used
      description: ''
      isArray: true
    - name: link_host
      description: ''
    - name: link_ability_ability_id
      description: link_ability ability_id.
    - name: link_ability_name
      description: link_ability name.
    - name: link_ability_buckets
      description: link_ability buckets.
    - name: link_ability_technique_id
      description: link_ability technique_id.
    - name: link_ability_delete_payload
      description: link_ability delete_payload.
    - name: link_ability_executors
      description: link_ability executors.
    - name: link_ability_privilege
      description: link_ability privilege.
    - name: link_ability_requirements
      description: link_ability requirements.
    - name: link_ability_plugin
      description: link_ability plugin.
    - name: link_ability_access
      description: link_ability access.
    - name: link_ability_tactic
      description: link_ability tactic.
    - name: link_ability_additional_info
      description: link_ability additional_info.
    - name: link_ability_singleton
      description: link_ability singleton.
    - name: link_ability_technique_name
      description: link_ability technique_name.
    - name: link_ability_repeatable
      description: link_ability repeatable.
    - name: link_ability_description
      description: link_ability description.
    - name: link_status
      description: ''
    - name: link_score
      description: ''
    - name: link_command
      description: ''
    - name: link_unique
      description: ''
    - name: link_cleanup
      description: ''
    - name: link_decide
      description: ''
    - name: link_facts
      description: ''
      isArray: true
    - name: link_executor_name
      description: link_executor name.
    - name: link_executor_cleanup
      description: link_executor cleanup.
    - name: link_executor_platform
      description: link_executor platform.
    - name: link_executor_language
      description: link_executor language.
    - name: link_executor_uploads
      description: link_executor uploads.
    - name: link_executor_variations
      description: link_executor variations.
    - name: link_executor_build_target
      description: link_executor build_target.
    - name: link_executor_payloads
      description: link_executor payloads.
    - name: link_executor_timeout
      description: link_executor timeout.
    - name: link_executor_parsers
      description: link_executor parsers.
    - name: link_executor_command
      description: link_executor command.
    - name: link_executor_additional_info
      description: link_executor additional_info.
    - name: link_executor_code
      description: link_executor code.
    - name: link_paw
      description: ''
    - name: link_output
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.output
      description: ''
  - name: caldera-create-schedule
    description: Create Schedule.
    arguments:
    - name: schedule_schedule
      description: ''
      required: true
    - name: schedule_task_name
      description: schedule_task name.
    - name: schedule_task_autonomous
      description: schedule_task autonomous.
    - name: schedule_task_id
      description: schedule_task id.
    - name: schedule_task_objective
      description: schedule_task objective.
    - name: schedule_task_visibility
      description: schedule_task visibility.
    - name: schedule_task_state
      description: schedule_task state.
    - name: schedule_task_group
      description: schedule_task group.
    - name: schedule_task_host_group
      description: schedule_task host_group.
    - name: schedule_task_planner
      description: schedule_task planner.
    - name: schedule_task_obfuscator
      description: schedule_task obfuscator.
    - name: schedule_task_chain
      description: schedule_task chain.
    - name: schedule_task_use_learning_parsers
      description: schedule_task use_learning_parsers.
    - name: schedule_task_source
      description: schedule_task source.
    - name: schedule_task_jitter
      description: schedule_task jitter.
    - name: schedule_task_start
      description: schedule_task start.
    - name: schedule_task_adversary
      description: schedule_task adversary.
    - name: schedule_task_auto_close
      description: schedule_task auto_close.
    - name: schedule_id
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Schedule.schedule
      description: ''
    - type: String
      contextPath: MitreCaldera.Schedule.id
      description: ''
  - name: caldera-delete-agent
    description: Delete an Agent.
    arguments:
    - name: paw
      description: paw of the Agent to be deleted.
      required: true
  - name: caldera-delete-fact-source
    description: Delete an existing Fact Source.
    arguments:
    - name: fact_source_id
      description: The id of the Fact Source to be deleted.
      required: true
  - name: caldera-delete-operation
    description: Delete an operation by operation id.
    arguments:
    - name: operation_id
      description: UUID of the Operation object to be retrieved.
      required: true
  - name: caldera-delete-facts
    description: Delete One or More Facts.
    arguments:
    - name: fact_unique
      description: ''
    - name: fact_name
      description: ''
    - name: fact_links
      description: ''
      isArray: true
    - name: fact_relationships
      description: ''
      isArray: true
    - name: fact_origin_type
      description: ''
    - name: fact_created
      description: ''
    - name: fact_limit_count
      description: ''
    - name: fact_technique_id
      description: ''
    - name: fact_trait
      description: ''
    - name: fact_source
      description: ''
    - name: fact_score
      description: ''
    - name: fact_value
      description: ''
    - name: fact_collected_by
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.score
      description: ''
  - name: caldera-delete-relationships
    description: Delete One or More Relationships.
    arguments:
    - name: relationship_unique
      description: ''
    - name: relationship_origin
      description: ''
    - name: relationship_edge
      description: ''
    - name: relationship_source_unique
      description: relationship_source unique.
    - name: relationship_source_name
      description: relationship_source name.
    - name: relationship_source_links
      description: relationship_source links.
    - name: relationship_source_relationships
      description: relationship_source relationships.
    - name: relationship_source_origin_type
      description: relationship_source origin_type.
    - name: relationship_source_created
      description: relationship_source created.
    - name: relationship_source_limit_count
      description: relationship_source limit_count.
    - name: relationship_source_technique_id
      description: relationship_source technique_id.
    - name: relationship_source_trait
      description: relationship_source trait.
    - name: relationship_source_source
      description: relationship_source source.
    - name: relationship_source_score
      description: relationship_source score.
    - name: relationship_source_value
      description: relationship_source value.
    - name: relationship_source_collected_by
      description: relationship_source collected_by.
    - name: relationship_score
      description: ''
    - name: relationship_target
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Relationship.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationship.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationship.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Relationship.score
      description: ''
  - name: caldera-delete-ability
    description: Deletes an ability.
    arguments:
    - name: ability_id
      description: UUID of the Ability to be deleted.
      required: true
  - name: caldera-delete-adversary
    description: Deletes an adversary.
    arguments:
    - name: adversary_id
      description: UUID of the adversary to be deleted.
      required: true
  - name: caldera-delete-schedule
    description: Delete Schedule.
    arguments:
    - name: schedule_id
      description: UUID of the Schedule to be deleted.
      required: true
  - name: caldera-get-abilities
    description: Get all Abilities with optional ability ID.
    arguments:
    - name: ability_id
      description: Optional UUID of the Ability to be retrieved.
    - name: sort
      description: Results are sorted if no Ability ID is provided.
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Abilities.ability_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.delete_payload
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.language
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.description
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.build_target
      description: ''
    - type: Number
      contextPath: MitreCaldera.Abilities.executors.timeout
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.edge
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.source
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.code
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.requirements.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.tactic
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.singleton
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.repeatable
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.description
      description: ''
  - name: caldera-get-adversaries
    description: Get all Adversaries with optional Adversary ID.
    arguments:
    - name: adversary_id
      description: Optional UUID of the adversary to be retrieved.
    - name: sort
      description: Results are sorted if no Adversary ID is provided.
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Adversaries.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.objective
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.adversary_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Adversaries.has_repeatable_abilities
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.description
      description: ''
  - name: caldera-get-agents
    description: Retrieves all agents with optional Agent PAW.
    arguments:
    - name: paw
      description: Optioanl PAW ID of the Agent to retrieve information about.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: Number
      contextPath: MitreCaldera.Agents.watchdog
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.output
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.deadman_enabled
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.ppid
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.created
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.origin_link_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.last_seen
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.pending_contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.host
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.group
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.location
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.display_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.upstream_dest
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.architecture
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.sleep_min
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.server
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.username
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.trusted
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.proxy_chain
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.exe_name
      description: ''
  - name: caldera-get-config
    description: Retrieve Config.
    arguments:
    - name: name
      description: 'Name of the configuration file to be retrieved (example: main).'
      required: true
      defaultValue: main
    outputs:
    - type: String
      contextPath: MitreCaldera.Name
      description: Config name.
    - type: Unknown
      contextPath: MitreCaldera.Config
      description: Config settings.
  - name: caldera-get-contacts
    description: Retrieve a List of all available Contact reports.
    arguments:
    - name: name
      description: Optional name of the contact to get beacons for, e.g. HTTP, TCP, et cetera.
    outputs:
    - type: Unknnown
      contextPath: MitreCaldera.Contacts
      description: List of contacts.
  - name: caldera-get-deploy-commands
    description: Retrieve deploy commands with optional Ability ID.
    arguments:
    - name: ability_id
      description: ID of the ability to retrieve deploy commands for.
    outputs:
    - type: String
      contextPath: MitreCaldera.DeployCommands.command
      description: Command.
    - type: String
      contextPath: MitreCaldera.DeployCommands.description
      description: Description.
    - type: String
      contextPath: MitreCaldera.DeployCommands.executor
      description: Executor.
    - type: String
      contextPath: MitreCaldera.DeployCommands.name
      description: Name.
    - type: String
      contextPath: MitreCaldera.DeployCommands.platform
      description: Platform.
    - type: String
      contextPath: MitreCaldera.DeployCommands.variations.command
      description: Command.
    - type: String
      contextPath: MitreCaldera.DeployCommands.variations.description
      description: Description.
  - name: caldera-get-facts
    description: Retrieve Facts with optional Operation ID.
    arguments:
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    - name: operation_id
      description: Optional Operation ID.
    outputs:
    - type: String
      contextPath: MitreCaldera.Facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.score
      description: ''
  - name: caldera-get-health
    description: Health endpoints returns the status of CALDERA.
    outputs:
    - type: String
      contextPath: MitreCaldera.CalderaInfo.application
      description: ''
    - type: String
      contextPath: MitreCaldera.CalderaInfo.version
      description: ''
    - type: String
      contextPath: MitreCaldera.CalderaInfo.plugins.name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.CalderaInfo.plugins.enabled
      description: ''
    - type: String
      contextPath: MitreCaldera.CalderaInfo.plugins.description
      description: ''
    - type: String
      contextPath: MitreCaldera.CalderaInfo.plugins.address
      description: ''
  - name: caldera-get-obfuscators
    description: Retrieve obfuscators with optional name.
    arguments:
    - name: name
      description: Name of the Obfuscator.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Obfuscators.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Obfuscators.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Obfuscators.description
      description: ''
  - name: caldera-get-objectives
    description: Retrieve objectives with optional Objective ID.
    arguments:
    - name: id
      description: Optional UUID of the objective to be retrieved.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Objectives.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.id
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Objectives.percentage
      description: ''
    - type: Number
      contextPath: MitreCaldera.Objectives.goals.count
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Objectives.goals.achieved
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.operator
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.value
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.description
      description: ''
  - name: caldera-get-operations
    description: Retrieve operations.
    arguments:
    - name: id
      description: Optional UUID of the Operation object to be retrieved.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Operations.name
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.autonomous
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.id
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.visibility
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.state
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.group
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.watchdog
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.output
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.deadman_enabled
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.ppid
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.created
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.origin_link_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.last_seen
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.pending_contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.host
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.group
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.location
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.display_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.upstream_dest
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.architecture
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.sleep_min
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.server
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.username
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.trusted
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.proxy_chain
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.exe_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.obfuscator
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.use_learning_parsers
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.start
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.auto_close
      description: ''
  - name: caldera-get-operation-links
    description: Get Links from Operation with optional Link ID.
    arguments:
    - name: operation_id
      description: ''
      required: true
    - name: link_id
      description: Optional UUID of the Link with the operation.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.OperationLinks.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.command
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.output
      description: ''
  - name: caldera-get-operation-links-result
    description: Retrieve the result of a link.
    arguments:
    - name: operation_id
      description: UUID of the operation object to be retrieved.
      required: true
    - name: link_id
      description: UUID of the link object to retrieve results of.
      required: true
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.OperationLinks.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.command
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.output
      description: ''
  - name: caldera-get-operations-potential-links
    description: Retrieve potential links for an operation with optional PAW.
    arguments:
    - name: operation_id
      description: UUID of the operation object to retrieve links for.
      required: true
    - name: paw
      description: Optional Agent paw for the specified operation.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.OperationLinks.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.command
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.OperationLinks.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.OperationLinks.output
      description: ''
  - name: caldera-get-planners
    description: Retrieve planners with optional Planner ID.
    arguments:
    - name: planner_id
      description: UUID of the Planner object to be retrieved.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Planners.name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Planners.allow_repeatable_abilities
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.stopping_conditions.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.stopping_conditions.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.stopping_conditions.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Planners.stopping_conditions.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.stopping_conditions.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.stopping_conditions.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.stopping_conditions.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Planners.stopping_conditions.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Planners.description
      description: ''
  - name: caldera-get-plugins
    description: Retrieve plugins with optional Name.
    arguments:
    - name: name
      description: The name of the plugin.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Plugins.name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Plugins.enabled
      description: ''
    - type: String
      contextPath: MitreCaldera.Plugins.address
      description: ''
    - type: Number
      contextPath: MitreCaldera.Plugins.access
      description: ''
    - type: String
      contextPath: MitreCaldera.Plugins.data_dir
      description: ''
    - type: String
      contextPath: MitreCaldera.Plugins.description
      description: ''
  - name: caldera-get-relationships
    description: Retrieve Relationships with optional Operation ID.
    arguments:
    - name: operation_id
      description: ''
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Relationships.score
      description: ''
  - name: caldera-get-schedules
    description: Retrieve Schedules with optional Schedule ID.
    arguments:
    - name: schedule_id
      description: Optional UUID of the Schedule to be retrieved.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Schedules.schedule
      description: ''
    - type: String
      contextPath: MitreCaldera.Schedules.id
      description: ''
  - name: caldera-get-sources
    description: Retrieve all Fact Sources with optional Fact Source ID.
    arguments:
    - name: source_id
      description: The id of the Fact Source.
    - name: sort
      description: ''
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Sources.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.ability_id
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.adjustments.offset
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.value
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.rules.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.rules.match
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.plugin
      description: ''
  - name: caldera-get-operation-event-logs
    description: Get Operation Event Logs.
    arguments:
    - name: operation_id
      description: ''
      required: true
    - name: enable_agent_output
      description: Whether to enable the agent output.
      auto: PREDEFINED
      predefined:
      - 'false'
      - 'true'
      defaultValue: 'false'
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.collected_timestamp
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.EventLogs.ability_metadata
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.EventLogs.attack_metadata
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.EventLogs.operation_metadata
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.finished_timestamp
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.EventLogs.agent_metadata
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.EventLogs.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.command
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.EventLogs.status
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.executor
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.EventLogs.delegated_timestamp
      description: ''
  - name: caldera-get-operation-report
    description: Get Operation Report.
    arguments:
    - name: operation_id
      description: ''
      required: true
    - name: enable_agent_output
      description: Whether to enable the agent output.
      auto: PREDEFINED
      predefined:
      - 'false'
      - 'true'
      defaultValue: 'false'
    - name: include
      description: ''
      isArray: true
    - name: exclude
      description: ''
      isArray: true
    outputs:
    - type: String
      contextPath: MitreCaldera.Operations.OperationReport.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.OperationReport.start
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.OperationReport.steps
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.OperationReport.facts
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.OperationReport.host_group
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.OperationReport.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.OperationReport.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.OperationReport.planner
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.OperationReport.finish
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.OperationReport.adversary
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.OperationReport.skipped_abilities
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Operations.OperationReport.objectives
      description: ''
  - name: caldera-replace-ability
    description: Replaces an existing ability.
    arguments:
    - name: ability_id
      description: UUID of the Ability to be retrieved.
      required: true
    - name: ability_name
      description: ''
    - name: ability_buckets
      description: ''
      isArray: true
    - name: ability_technique_id
      description: ''
    - name: ability_delete_payload
      description: ''
    - name: ability_executors
      description: ''
      isArray: true
    - name: ability_privilege
      description: ''
    - name: ability_requirements
      description: ''
      isArray: true
    - name: ability_plugin
      description: ''
    - name: ability_access
      description: ''
    - name: ability_tactic
      description: ''
    - name: ability_additional_info
      description: ''
    - name: ability_singleton
      description: ''
    - name: ability_technique_name
      description: ''
    - name: ability_repeatable
      description: ''
    - name: ability_description
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Abilities.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.delete_payload
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.language
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.description
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.build_target
      description: ''
    - type: Number
      contextPath: MitreCaldera.Abilities.executors.timeout
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.edge
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.source
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.code
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.requirements.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.tactic
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.singleton
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.repeatable
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.description
      description: ''
  - name: caldera-replace-schedule
    description: Replace Schedule.
    arguments:
    - name: schedule_id
      description: UUID of the Schedule to be replaced.
      required: true
    - name: partial_schedule_schedule
      description: ''
    - name: partial_schedule_task_name
      description: partial_schedule_task name.
    - name: partial_schedule_task_autonomous
      description: partial_schedule_task autonomous.
    - name: partial_schedule_task_id
      description: partial_schedule_task id.
    - name: partial_schedule_task_objective
      description: partial_schedule_task objective.
    - name: partial_schedule_task_visibility
      description: partial_schedule_task visibility.
    - name: partial_schedule_task_state
      description: partial_schedule_task state.
    - name: partial_schedule_task_group
      description: partial_schedule_task group.
    - name: partial_schedule_task_host_group
      description: partial_schedule_task host_group.
    - name: partial_schedule_task_planner
      description: partial_schedule_task planner.
    - name: partial_schedule_task_obfuscator
      description: partial_schedule_task obfuscator.
    - name: partial_schedule_task_chain
      description: partial_schedule_task chain.
    - name: partial_schedule_task_use_learning_parsers
      description: partial_schedule_task use_learning_parsers.
    - name: partial_schedule_task_source
      description: partial_schedule_task source.
    - name: partial_schedule_task_jitter
      description: partial_schedule_task jitter.
    - name: partial_schedule_task_start
      description: partial_schedule_task start.
    - name: partial_schedule_task_adversary
      description: partial_schedule_task adversary.
    - name: partial_schedule_task_auto_close
      description: partial_schedule_task auto_close.
    outputs:
    - type: String
      contextPath: MitreCaldera.Schedules.schedule
      description: ''
    - type: String
      contextPath: MitreCaldera.Schedules.id
      description: ''
  - name: caldera-update-agent-config
    description: Update Agent Config.
    arguments:
    - name: watchdog
      description: ''
    - name: sleep_min
      description: ''
    - name: deployments
      description: ''
      isArray: true
    - name: deadman_abilities
      description: ''
      isArray: true
    - name: untrusted_timer
      description: ''
    - name: bootstrap_abilities
      description: ''
      isArray: true
    - name: sleep_max
      description: ''
    - name: implant_name
      description: ''
    outputs:
    - type: Number
      contextPath: MitreCaldera.AgentConfig.watchdog
      description: ''
    - type: Number
      contextPath: MitreCaldera.AgentConfig.sleep_min
      description: ''
    - type: Number
      contextPath: MitreCaldera.AgentConfig.untrusted_timer
      description: ''
    - type: Number
      contextPath: MitreCaldera.AgentConfig.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.AgentConfig.implant_name
      description: ''
  - name: caldera-update-adversary
    description: Update an adversary.
    arguments:
    - name: adversary_id
      description: UUID of the adversary to be updated.
      required: true
    - name: adversaryname
      description: ''
    - name: adversarytags
      description: ''
      isArray: true
    - name: adversaryobjective
      description: ''
    - name: adversaryhas_repeatable_abilities
      description: ''
    - name: adversaryatomic_ordering
      description: ''
      isArray: true
    - name: adversaryplugin
      description: ''
    - name: adversarydescription
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Adversaries.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.objective
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.adversary_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Adversaries.has_repeatable_abilities
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Adversaries.description
      description: ''
  - name: caldera-update-agent
    description: Update an Agent.
    arguments:
    - name: paw
      description: ID of the Agent to update.
      required: true
    - name: watchdog
      description: ''
    - name: sleep_min
      description: ''
    - name: trusted
      description: ''
    - name: sleep_max
      description: ''
    - name: pending_contact
      description: ''
    - name: group
      description: ''
    outputs:
    - type: Number
      contextPath: MitreCaldera.Agents.watchdog
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.links.output
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.deadman_enabled
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.ppid
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.created
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.origin_link_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.last_seen
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.pending_contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.host
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.group
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.location
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.display_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.upstream_dest
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.architecture
      description: ''
    - type: Number
      contextPath: MitreCaldera.Agents.sleep_min
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.server
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.username
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Agents.trusted
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.proxy_chain
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Agents.exe_name
      description: ''
  - name: caldera-update-fact-source
    description: Update an existing Fact Source.
    arguments:
    - name: fact_source_id
      description: The id of the Fact Source.
      required: true
    - name: source_name
      description: ''
    - name: source_adjustments
      description: ''
      isArray: true
    - name: source_relationships
      description: ''
      isArray: true
    - name: source_id
      description: ''
    - name: source_rules
      description: ''
      isArray: true
    - name: source_facts
      description: ''
      isArray: true
    - name: source_plugin
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Sources.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.ability_id
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.adjustments.offset
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.adjustments.value
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.rules.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.rules.match
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Sources.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Sources.plugin
      description: ''
  - name: caldera-update-objective
    description: Update an objective.
    arguments:
    - name: objective_id
      description: UUID of the Objective to be updated.
      required: true
    - name: name
      description: ''
    - name: goals
      description: ''
      isArray: true
    - name: description
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Objectives.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.id
      description: ''
    - type: Unknown
      contextPath: MitreCaldera.Objectives.percentage
      description: ''
    - type: Number
      contextPath: MitreCaldera.Objectives.goals.count
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Objectives.goals.achieved
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.operator
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.value
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.goals.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Objectives.description
      description: ''
  - name: caldera-update-operation-fields
    description: Update fields within an operation.
    arguments:
    - name: operation_id
      description: UUID of the Operation object to be retrieved.
      required: true
    - name: obfuscator
      description: ''
    - name: autonomous
      description: ''
    - name: state
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Operations.name
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.autonomous
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.id
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.visibility
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.state
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.group
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.watchdog
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.links.output
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.deadman_enabled
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.ppid
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.created
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.origin_link_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.last_seen
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.pending_contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.host
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.group
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.location
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.display_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.upstream_dest
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.sleep_max
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.architecture
      description: ''
    - type: Number
      contextPath: MitreCaldera.Operations.host_group.sleep_min
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.server
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.contact
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.username
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.host_group.trusted
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.proxy_chain
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.host_group.exe_name
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.obfuscator
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.use_learning_parsers
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Operations.start
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Operations.auto_close
      description: ''
  - name: caldera-update-main-config
    description: Update Main Config.
    arguments:
    - name: property
      description: ''
      required: true
    - name: value
      description: ''
      required: true
  - name: caldera-update-facts
    description: Update One or More Facts.
    arguments:
    - name: unique
      description: partial_factupdaterequest_updates unique.
    - name: name
      description: partial_factupdaterequest_updates name.
    - name: links
      description: partial_factupdaterequest_updates links.
    - name: relationships
      description: partial_factupdaterequest_updates relationships.
    - name: origin_type
      description: partial_factupdaterequest_updates origin_type.
    - name: created
      description: partial_factupdaterequest_updates created.
    - name: limit_count
      description: partial_factupdaterequest_updates limit_count.
    - name: technique_id
      description: partial_factupdaterequest_updates technique_id.
    - name: trait
      description: partial_factupdaterequest_updates trait.
    - name: source
      description: partial_factupdaterequest_updates source.
    - name: score
      description: partial_factupdaterequest_updates score.
    - name: value
      description: partial_factupdaterequest_updates value.
    - name: collected_by
      description: partial_factupdaterequest_updates collected_by.
    - name: criteria_unique
      description: partial_factupdaterequest_criteria unique.
    - name: criteria_name
      description: partial_factupdaterequest_criteria name.
    - name: criteria_links
      description: partial_factupdaterequest_criteria links.
    - name: criteria_relationships
      description: partial_factupdaterequest_criteria relationships.
    - name: criteria_origin_type
      description: partial_factupdaterequest_criteria origin_type.
    - name: criteria_created
      description: partial_factupdaterequest_criteria created.
    - name: criteria_limit_count
      description: partial_factupdaterequest_criteria limit_count.
    - name: criteria_technique_id
      description: partial_factupdaterequest_criteria technique_id.
    - name: criteria_trait
      description: partial_factupdaterequest_criteria trait.
    - name: criteria_source
      description: partial_factupdaterequest_criteria source.
    - name: criteria_score
      description: partial_factupdaterequest_criteria score.
    - name: criteria_value
      description: partial_factupdaterequest_criteria value.
    - name: criteria_collected_by
      description: partial_factupdaterequest_criteria collected_by.
    outputs:
    - type: String
      contextPath: MitreCaldera.Facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Facts.score
      description: ''
  - name: caldera-update-relationships
    description: Update One or More Relationships.
    arguments:
    - name: unique
      description: partial_relationshipupdate_updates unique.
    - name: origin
      description: partial_relationshipupdate_updates origin.
    - name: edge
      description: partial_relationshipupdate_updates edge.
    - name: source
      description: partial_relationshipupdate_updates source.
    - name: score
      description: partial_relationshipupdate_updates score.
    - name: target
      description: partial_relationshipupdate_updates target.
    - name: criteria_unique
      description: partial_relationshipupdate_criteria unique.
    - name: criteria_origin
      description: partial_relationshipupdate_criteria origin.
    - name: criteria_edge
      description: partial_relationshipupdate_criteria edge.
    - name: criteria_source
      description: partial_relationshipupdate_criteria source.
    - name: criteria_score
      description: partial_relationshipupdate_criteria score.
    - name: criteria_target
      description: partial_relationshipupdate_criteria target.
    outputs:
    - type: String
      contextPath: MitreCaldera.Relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Relationships.score
      description: ''
  - name: caldera-update-ability
    description: Updates an existing ability.
    arguments:
    - name: ability_id
      description: UUID of the Ability to be retrieved.
      required: true
    - name: name
      description: ''
    - name: buckets
      description: ''
      isArray: true
    - name: technique_id
      description: ''
    - name: delete_payload
      description: ''
    - name: executors
      description: ''
      isArray: true
    - name: privilege
      description: ''
    - name: technique_name
      description: ''
    - name: tactic
      description: ''
    - name: singleton
      description: ''
    - name: plugin
      description: ''
    - name: repeatable
      description: ''
    - name: description
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Abilities.ability_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_id
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.delete_payload
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.platform
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.language
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.variations.description
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.build_target
      description: ''
    - type: Number
      contextPath: MitreCaldera.Abilities.executors.timeout
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.edge
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.source
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.parsers.parserconfigs.target
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.executors.code
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.privilege
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.requirements.module
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.plugin
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.tactic
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.singleton
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.technique_name
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Abilities.repeatable
      description: ''
    - type: String
      contextPath: MitreCaldera.Abilities.description
      description: ''
  - name: caldera-update-schedule
    description: Update Schedule.
    arguments:
    - name: schedule_id
      description: UUID of the Schedule to be updated.
      required: true
    - name: schedule
      description: ''
    - name: task_obfuscator
      description: task obfuscator.
    - name: task_autonomous
      description: task autonomous.
    - name: task_state
      description: task state.
    outputs:
    - type: String
      contextPath: MitreCaldera.Schedules.schedule
      description: ''
    - type: String
      contextPath: MitreCaldera.Schedules.id
      description: ''
  - name: caldera-update-operation-link
    description: Update the specified link within an operation.
    arguments:
    - name: operation_id
      description: String UUID of the Operation containing desired link.
      required: true
    - name: link_id
      description: String UUID of the Link with the above operation.
      required: true
    - name: command
      description: ''
    - name: status
      description: ''
    outputs:
    - type: String
      contextPath: MitreCaldera.Links.relationships.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.relationships.origin
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.relationships.edge
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.relationships.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.id
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.collect
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.pid
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.finish
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.pin
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.jitter
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.agent_reported_time
      description: ''
    - type: Boolean
      contextPath: MitreCaldera.Links.deadman
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.used.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.used.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.used.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.host
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.status
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.command
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.unique
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.cleanup
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.decide
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.unique
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.name
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.created
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.facts.limit_count
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.technique_id
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.trait
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.facts.source
      description: ''
    - type: Number
      contextPath: MitreCaldera.Links.facts.score
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.paw
      description: ''
    - type: String
      contextPath: MitreCaldera.Links.output
      description: ''
fromversion: 6.2.0
tests:
- No tests (auto formatted)