activity_template

Get Activity Template

Get an activity template by ID.

get/api/v1/activity_template/{activity_template_id}

Request

The document declares no server URL.
Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

activity_template_idstring uuid required

Response

Successful Response

activity_actionsstring nullable

activity_notesstring nullable

activity_rationalestring nullable

activity_requirementsstring nullable

expected_loggingboolean nullable

expected_alert_creationboolean nullable

expected_preventionboolean nullable

expected_stakeholder_notificationboolean nullable

expected_severity'Informational' | 'Low' | 'Medium' | 'High' | 'Critical'

Possible activity severity levels

mitre_tacticstring required

mitre_techniquestring required

namestring required

priority'Low' | 'Medium' | 'High' | 'Critical'

Possible activity priority levels

providerstring required

linked_knowledge_base_articlesstring[] nullable

idstring uuid required

Example response

{
  "activity_actions": "",
  "activity_notes": "",
  "activity_rationale": "Users or attackers might visit known malicious sites from the system.",
  "activity_requirements": "Standard Windows workplace with Internet access.",
  "expected_alert_creation": true,
  "expected_logging": true,
  "expected_prevention": true,
  "expected_severity": "Medium",
  "expected_stakeholder_notification": false,
  "id": "00000000-0000-0000-0000-000000000000",
  "mitre_tactic": "Execution",
  "mitre_technique": "T1204.001",
  "name": "Windows: Malicious Link Execution on Client",
  "priority": "Medium",
  "provider": "Compass Security"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.