Custom Framework API Spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-28 14:02:49.518230",
-            "spec_repo_commit": "8964dc24"
+            "regenerated": "2025-04-29 16:14:54.910782",
+            "spec_repo_commit": "22937387"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-04-28 14:02:58.710366",
-            "spec_repo_commit": "8964dc24"
+            "regenerated": "2025-04-29 16:15:04.110142",
+            "spec_repo_commit": "22937387"
         }
     }
 }

config/_default/menus/api.en.yaml

@@ -2863,6 +2863,54 @@ menu:
         unstable:
           - v2
         order: 1
+    - name: Update a custom framework
+      url: '#update-a-custom-framework'
+      identifier: security-monitoring-update-a-custom-framework
+      parent: security-monitoring
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - UpdateCustomFramework
+        unstable: []
+        order: 4
+    - name: Get a custom framework
+      url: '#get-a-custom-framework'
+      identifier: security-monitoring-get-a-custom-framework
+      parent: security-monitoring
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - GetCustomFramework
+        unstable: []
+        order: 4
+    - name: Delete a custom framework
+      url: '#delete-a-custom-framework'
+      identifier: security-monitoring-delete-a-custom-framework
+      parent: security-monitoring
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - DeleteCustomFramework
+        unstable: []
+        order: 4
+    - name: Create a custom framework
+      url: '#create-a-custom-framework'
+      identifier: security-monitoring-create-a-custom-framework
+      parent: security-monitoring
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - CreateCustomFramework
+        unstable: []
+        order: 4
     - name: Change the triage state of a security signal
       url: '#change-the-triage-state-of-a-security-signal'
       identifier: security-monitoring-change-the-triage-state-of-a-security-signal

content/en/api/v2/security-monitoring/request.CreateCustomFramework.json

@@ -0,0 +1,24 @@
+{
+  "data": {
+    "type": "custom_framework",
+    "attributes": {
+      "name": "name",
+      "handle": "create-framework-new",
+      "version": "10",
+      "icon_url": "test-url",
+      "requirements": [
+        {
+          "name": "requirement",
+          "controls": [
+            {
+              "name": "control",
+              "rules_id": [
+                "def-000-be9"
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

content/en/api/v2/security-monitoring/request.UpdateCustomFramework.json

@@ -0,0 +1,24 @@
+{
+  "data": {
+    "type": "custom_framework",
+    "attributes": {
+      "name": "name",
+      "handle": "create-framework-new",
+      "version": "10",
+      "icon_url": "test-url",
+      "requirements": [
+        {
+          "name": "requirement",
+          "controls": [
+            {
+              "name": "control",
+              "rules_id": [
+                "def-000-be9"
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

data/api/v2/CodeExamples.json

@@ -1113,6 +1113,13 @@
       "description": "Create a detection rule with type 'workload_security' returns \"OK\" response"
     }
   ],
+  "CreateCustomFramework": [
+    {
+      "group": "security_monitoring",
+      "suffix": "",
+      "description": "Create a custom framework returns \"OK\" response"
+    }
+  ],
   "CreateSignalNotificationRule": [
     {
       "group": "security_monitoring",
@@ -1207,6 +1214,13 @@
       "description": "Update an existing rule returns \"OK\" response"
     }
   ],
+  "UpdateCustomFramework": [
+    {
+      "group": "security_monitoring",
+      "suffix": "",
+      "description": "Update a custom framework returns \"OK\" response"
+    }
+  ],
   "UpdateSecurityFilter": [
     {
       "group": "security_monitoring",