activity_template

Get Activity Templates

Get all activity templates.

get/api/v1/activity_template/

Request

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

Query parameters

offsetinteger
limitinteger
sort_order'asc' | 'desc' nullable
namestring nullable
mitre_tacticstring nullable
mitre_techniquestring nullable
providerstring nullable
priorityActivityPriority[] nullable
sort_by'name' | 'mitre_tactic' | 'mitre_technique' | 'provider' | 'priority' nullable

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Example response

{
  "items": [
    {
      "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.