> For the complete documentation index, see [llms.txt](https://ai-security-docs.akto.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ai-security-docs.akto.io/api-reference/integration/modify-data.md). # Modify Data ## Table of Contents * [#jira](#jira "mention") * [#azure-boards](#azure-boards "mention") * [#datadog](#datadog "mention") * [#splunk](#splunk "mention") * [#azure-data-explorer-adx](#azure-data-explorer-adx "mention") * [#devrev](#devrev "mention") * [#servicenow](#servicenow "mention") * [#microsoft-defender](#microsoft-defender "mention") * [#sentinelone](#sentinelone "mention") * [#generic-integrations](#generic-integrations "mention") * [#slack-webhooks](#slack-webhooks "mention") * [#custom-webhooks](#custom-webhooks "mention") ## Jira
#APIDescription
1POST /api/jira/addAdds a Jira project to the integration or updates bi-directional sync settings for an existing one. Supports both Jira Cloud (v3 API) and Data Center (v2 API).
2POST /api/jira/deleteRemoves a Jira project from the integration.
3POST /api/jira/savePriorityFieldMappingSaves the mapping from Akto severity levels to Jira field values for a project.
4POST /api/createJiraIssueCreates a Jira issue linked to an Akto testing run issue and stores the resulting Jira ticket URL.
5POST /api/bulkCreateJiraTicketsBulk creates Jira issues for multiple Akto testing run issues in a single request.
6POST /api/attachFileToIssueAttaches original and test HTTP request/response samples as a file to an existing Jira issue.
7POST /api/createGeneralJiraTicketCreates a general-purpose Jira ticket not tied to a specific testing run issue.
## POST /api/jira/add > POST request for endpoint /api/jira/add ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/jira/add":{"post":{"summary":"POST request for endpoint /api/jira/add","operationId":"/api/jira/add-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["baseUrl","userEmail","apiToken","jiraType","projectMappings"],"properties":{"baseUrl":{"type":"string"},"userEmail":{"type":"string"},"apiToken":{"type":"string"},"jiraType":{"type":"string","enum":["CLOUD","DATA_CENTER"]},"projectMappings":{"type":"object","description":"Map of project key to project mapping settings","additionalProperties":{"type":"object","properties":{"biDirectionalSyncSettings":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"statuses":{"type":"array","items":{"type":"object"}}}}}}}}}},"responses":{"200":{"description":"Jira project added/updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"jiraIntegration":{"type":"object","properties":{"baseUrl":{"type":"string"},"userEmail":{"type":"string"},"projectIdsMap":{"type":"object","description":"Map of project key to issue type list"},"projectMappings":{"type":"object"},"createdTs":{"type":"integer"},"updatedTs":{"type":"integer"}}}}}}}},"403":{"description":"Forbidden — caller lacks INTEGRATIONS / READ_WRITE permission"},"422":{"description":"Unprocessable — project mappings empty or project metadata fetch failed","content":{"application/json":{"schema":{"type":"object","properties":{"actionErrors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## POST /api/jira/delete > POST request for endpoint /api/jira/delete ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/jira/delete":{"post":{"summary":"POST request for endpoint /api/jira/delete","operationId":"/api/jira/delete-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projId"],"properties":{"projId":{"type":"string","description":"Jira project key to remove"}}}}}},"responses":{"200":{"description":"Project removed successfully","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — projId null or integration not found","content":{"application/json":{"schema":{"type":"object","properties":{"actionErrors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## POST /api/jira/savePriorityFieldMapping > POST request for endpoint /api/jira/savePriorityFieldMapping ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/jira/savePriorityFieldMapping":{"post":{"summary":"POST request for endpoint /api/jira/savePriorityFieldMapping","operationId":"/api/jira/savePriorityFieldMapping-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projId","fieldId","fieldValuesMap"],"properties":{"projId":{"type":"string"},"fieldId":{"type":"string"},"fieldValuesMap":{"type":"object","description":"Map of Akto severity → Jira field value ID"}}}}}},"responses":{"200":{"description":"Priority mapping saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/createJiraIssue > POST request for endpoint /api/createJiraIssue ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createJiraIssue":{"post":{"summary":"POST request for endpoint /api/createJiraIssue","operationId":"/api/createJiraIssue-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["jiraMetaData"],"properties":{"jiraMetaData":{"type":"object","properties":{"testingIssueId":{"type":"object","properties":{"apiInfoKey":{"type":"object","properties":{"apiCollectionId":{"type":"integer"},"url":{"type":"string"},"method":{"type":"string"}}},"testSubCategory":{"type":"string"}}},"projId":{"type":"string"},"issueType":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Jira issue created","content":{"application/json":{"schema":{"type":"object","properties":{"jiraTicketKey":{"type":"string"},"jiraTicketUrl":{"type":"string"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — Jira not integrated or Jira API error"}}}}}} ``` ## POST /api/bulkCreateJiraTickets > POST request for endpoint /api/bulkCreateJiraTickets ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/bulkCreateJiraTickets":{"post":{"summary":"POST request for endpoint /api/bulkCreateJiraTickets","operationId":"/api/bulkCreateJiraTickets-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["testingRunIssueIds","jiraMetaData"],"properties":{"testingRunIssueIds":{"type":"array","description":"List of testing run issue IDs to create Jira tickets for","items":{"type":"object","properties":{"apiInfoKey":{"type":"object","properties":{"apiCollectionId":{"type":"integer"},"url":{"type":"string"},"method":{"type":"string"}}},"testSubCategory":{"type":"string"}}}},"jiraMetaData":{"type":"object","properties":{"projId":{"type":"string"},"issueType":{"type":"string"}}}}}}}},"responses":{"200":{"description":"Bulk Jira tickets created","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/attachFileToIssue > POST request for endpoint /api/attachFileToIssue ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/attachFileToIssue":{"post":{"summary":"POST request for endpoint /api/attachFileToIssue","operationId":"/api/attachFileToIssue-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["issueId"],"properties":{"origReq":{"type":"string","description":"Raw HTTP request/response sample (original traffic)"},"testReq":{"type":"string","description":"Raw HTTP request/response sample (test attempt)"},"issueId":{"type":"string","description":"Jira issue key"}}}}}},"responses":{"200":{"description":"File attached to issue","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — Jira not integrated or attachment failed"}}}}}} ``` ## POST /api/createGeneralJiraTicket > POST request for endpoint /api/createGeneralJiraTicket ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createGeneralJiraTicket":{"post":{"summary":"POST request for endpoint /api/createGeneralJiraTicket","operationId":"/api/createGeneralJiraTicket-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["projId","issueType","title"],"properties":{"projId":{"type":"string"},"issueType":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"labels":{"type":"string"},"threatEventId":{"type":"string"},"actionItemType":{"type":"string"}}}}}},"responses":{"200":{"description":"Jira ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"jiraTicketUrl":{"type":"string"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — Jira not integrated"}}}}}} ``` ## Azure Boards
#APIDescription
1POST /api/addAzureBoardsIntegrationAdds or updates the Azure Boards integration configuration.
2POST /api/removeAzureBoardsIntegrationRemoves the Azure Boards integration configuration.
3POST /api/createAzureBoardsWorkItemCreates an Azure Boards work item linked to an Akto testing run issue.
4POST /api/bulkCreateAzureWorkItemsBulk creates Azure Boards work items for multiple Akto testing run issues in a single request.
5POST /api/createGeneralAzureBoardsWorkItemCreates a general-purpose Azure Boards work item not tied to a specific testing run issue.
## POST /api/addAzureBoardsIntegration > POST request for endpoint /api/addAzureBoardsIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addAzureBoardsIntegration":{"post":{"summary":"POST request for endpoint /api/addAzureBoardsIntegration","operationId":"/api/addAzureBoardsIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["azureBoardsBaseUrl","organization","projectList","personalAuthToken"],"properties":{"azureBoardsBaseUrl":{"type":"string"},"organization":{"type":"string"},"projectList":{"type":"array","items":{"type":"string"}},"personalAuthToken":{"type":"string"}}}}}},"responses":{"200":{"description":"Integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — invalid credentials or project not found"}}}}}} ``` ## POST /api/removeAzureBoardsIntegration > POST request for endpoint /api/removeAzureBoardsIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/removeAzureBoardsIntegration":{"post":{"summary":"POST request for endpoint /api/removeAzureBoardsIntegration","operationId":"/api/removeAzureBoardsIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Integration removed","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/createAzureBoardsWorkItem > POST request for endpoint /api/createAzureBoardsWorkItem ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createAzureBoardsWorkItem":{"post":{"summary":"POST request for endpoint /api/createAzureBoardsWorkItem","operationId":"/api/createAzureBoardsWorkItem-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["workItemType","projectName"],"properties":{"workItemType":{"type":"string"},"projectName":{"type":"string"},"testingIssuesId":{"type":"object","properties":{"apiInfoKey":{"type":"object","properties":{"apiCollectionId":{"type":"integer"},"url":{"type":"string"},"method":{"type":"string"}}},"testSubCategory":{"type":"string"}}},"aktoDashboardHostName":{"type":"string"},"threatEventId":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"Work item created","content":{"application/json":{"schema":{"type":"object","properties":{"azureBoardsWorkItemUrl":{"type":"string"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — integration not configured"}}}}}} ``` ## POST /api/bulkCreateAzureWorkItems > POST request for endpoint /api/bulkCreateAzureWorkItems ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/bulkCreateAzureWorkItems":{"post":{"summary":"POST request for endpoint /api/bulkCreateAzureWorkItems","operationId":"/api/bulkCreateAzureWorkItems-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["testingIssuesIdList","projectName","workItemType"],"properties":{"testingIssuesIdList":{"type":"array","items":{"type":"object"},"description":"Array of TestingIssuesId objects"},"projectName":{"type":"string"},"workItemType":{"type":"string"},"aktoDashboardHostName":{"type":"string"}}}}}},"responses":{"200":{"description":"Work items created","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/createGeneralAzureBoardsWorkItem > POST request for endpoint /api/createGeneralAzureBoardsWorkItem ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createGeneralAzureBoardsWorkItem":{"post":{"summary":"POST request for endpoint /api/createGeneralAzureBoardsWorkItem","operationId":"/api/createGeneralAzureBoardsWorkItem-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["workItemType","projectName","title"],"properties":{"workItemType":{"type":"string"},"projectName":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"threatEventId":{"type":"string"},"templateId":{"type":"string"},"endpoint":{"type":"string"},"originalMessage":{"type":"string"}}}}}},"responses":{"200":{"description":"Work item created","content":{"application/json":{"schema":{"type":"object","properties":{"azureBoardsWorkItemUrl":{"type":"string"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — integration not configured"}}}}}} ``` ## Datadog
#APIDescription
1POST /api/saveDataDogConfigsSaves Datadog configuration settings for the integration.
2POST /api/addDatadogIntegrationAdds or updates the Datadog integration configuration.
3POST /api/deleteDatadogIntegrationRemoves the Datadog integration configuration.
4POST /api/testDatadogIntegrationTests the Datadog integration by sending a test event to verify connectivity.
## POST /api/saveDataDogConfigs > POST request for endpoint /api/saveDataDogConfigs ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/saveDataDogConfigs":{"post":{"summary":"POST request for endpoint /api/saveDataDogConfigs","operationId":"/api/saveDataDogConfigs-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["datadogApiKey","datadogAppKey","datadogSite"],"properties":{"datadogApiKey":{"type":"string"},"datadogAppKey":{"type":"string"},"datadogSite":{"type":"string"},"serviceNames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Datadog config saved; hourly traffic collection job scheduled","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — missing API key, app key, or site","content":{"application/json":{"schema":{"type":"object","properties":{"actionErrors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## POST /api/addDatadogIntegration > POST request for endpoint /api/addDatadogIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addDatadogIntegration":{"post":{"summary":"POST request for endpoint /api/addDatadogIntegration","operationId":"/api/addDatadogIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["apiKey","datadogSite"],"properties":{"apiKey":{"type":"string"},"datadogSite":{"type":"string"},"enabled":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Datadog integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/deleteDatadogIntegration > POST request for endpoint /api/deleteDatadogIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/deleteDatadogIntegration":{"post":{"summary":"POST request for endpoint /api/deleteDatadogIntegration","operationId":"/api/deleteDatadogIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Datadog integration deleted","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/testDatadogIntegration > POST request for endpoint /api/testDatadogIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/testDatadogIntegration":{"post":{"summary":"POST request for endpoint /api/testDatadogIntegration","operationId":"/api/testDatadogIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["apiKey","datadogSite"],"properties":{"apiKey":{"type":"string"},"datadogSite":{"type":"string"}}}}}},"responses":{"200":{"description":"Test event sent successfully","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — connection test failed"}}}}}} ``` ## Splunk
#APIDescription
1POST /api/addSplunkIntegrationAdds or updates the Splunk SIEM integration configuration.
## POST /api/addSplunkIntegration > POST request for endpoint /api/addSplunkIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addSplunkIntegration":{"post":{"summary":"POST request for endpoint /api/addSplunkIntegration","operationId":"/api/addSplunkIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["splunkUrl","splunkToken"],"properties":{"splunkUrl":{"type":"string"},"splunkToken":{"type":"string"}}}}}},"responses":{"200":{"description":"Splunk integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## Azure Data Explorer (ADX)
#APIDescription
1POST /api/addAdxIntegrationAdds or updates the Azure Data Explorer integration configuration.
2POST /api/removeAdxIntegrationRemoves the Azure Data Explorer integration configuration.
## POST /api/addAdxIntegration > POST request for endpoint /api/addAdxIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addAdxIntegration":{"post":{"summary":"POST request for endpoint /api/addAdxIntegration","operationId":"/api/addAdxIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["clusterEndpoint","databaseName","tenantId","applicationClientId"],"properties":{"clusterEndpoint":{"type":"string"},"databaseName":{"type":"string"},"tenantId":{"type":"string"},"applicationClientId":{"type":"string"},"applicationKey":{"type":"string","description":"Azure AD application client secret. Required on first save; can be omitted on subsequent updates to keep the stored value."}}}}}},"responses":{"200":{"description":"ADX integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — missing required fields","content":{"application/json":{"schema":{"type":"object","properties":{"actionErrors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## POST /api/removeAdxIntegration > POST request for endpoint /api/removeAdxIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/removeAdxIntegration":{"post":{"summary":"POST request for endpoint /api/removeAdxIntegration","operationId":"/api/removeAdxIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"ADX integration removed","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## DevRev
#APIDescription
1POST /api/addDevRevIntegrationAdds or updates the DevRev integration configuration.
2POST /api/removeDevRevIntegrationRemoves the DevRev integration configuration.
3POST /api/createDevRevTicketsCreates DevRev tickets linked to Akto testing run issues.
## POST /api/addDevRevIntegration > POST request for endpoint /api/addDevRevIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addDevRevIntegration":{"post":{"summary":"POST request for endpoint /api/addDevRevIntegration","operationId":"/api/addDevRevIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["orgUrl","personalAccessToken"],"properties":{"orgUrl":{"type":"string"},"personalAccessToken":{"type":"string"}}}}}},"responses":{"200":{"description":"DevRev integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/removeDevRevIntegration > POST request for endpoint /api/removeDevRevIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/removeDevRevIntegration":{"post":{"summary":"POST request for endpoint /api/removeDevRevIntegration","operationId":"/api/removeDevRevIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"DevRev integration removed","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/createDevRevTickets > POST request for endpoint /api/createDevRevTickets ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createDevRevTickets":{"post":{"summary":"POST request for endpoint /api/createDevRevTickets","operationId":"/api/createDevRevTickets-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["testingIssuesIdList","partId","workItemType"],"properties":{"testingIssuesIdList":{"type":"array","items":{"type":"object"},"description":"Array of TestingIssuesId objects"},"partId":{"type":"string"},"workItemType":{"type":"string"},"aktoDashboardHost":{"type":"string"}}}}}},"responses":{"200":{"description":"DevRev tickets created","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — integration not configured"}}}}}} ``` ## ServiceNow
#APIDescription
1POST /api/addServiceNowIntegrationAdds or updates the ServiceNow integration configuration.
2POST /api/removeServiceNowIntegrationRemoves the ServiceNow integration configuration.
3POST /api/createServiceNowTicketCreates a ServiceNow ticket linked to an Akto testing run issue.
4POST /api/bulkCreateServiceNowTicketsBulk creates ServiceNow tickets for multiple Akto testing run issues in a single request.
## POST /api/addServiceNowIntegration > POST request for endpoint /api/addServiceNowIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addServiceNowIntegration":{"post":{"summary":"POST request for endpoint /api/addServiceNowIntegration","operationId":"/api/addServiceNowIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["instanceUrl","clientId","clientSecret","tableNames"],"properties":{"instanceUrl":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"tableNames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"ServiceNow integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/removeServiceNowIntegration > POST request for endpoint /api/removeServiceNowIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/removeServiceNowIntegration":{"post":{"summary":"POST request for endpoint /api/removeServiceNowIntegration","operationId":"/api/removeServiceNowIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"ServiceNow integration removed","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/createServiceNowTicket > POST request for endpoint /api/createServiceNowTicket ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createServiceNowTicket":{"post":{"summary":"POST request for endpoint /api/createServiceNowTicket","operationId":"/api/createServiceNowTicket-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["testingIssuesId","tableName"],"properties":{"testingIssuesId":{"type":"object","properties":{"apiInfoKey":{"type":"object","properties":{"apiCollectionId":{"type":"integer"},"url":{"type":"string"},"method":{"type":"string"}}},"testSubCategory":{"type":"string"}}},"tableName":{"type":"string"},"aktoDashboardHostName":{"type":"string"}}}}}},"responses":{"200":{"description":"ServiceNow ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"serviceNowTicketUrl":{"type":"string"},"serviceNowTicketNumber":{"type":"string"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — integration not configured or API error"}}}}}} ``` ## POST /api/bulkCreateServiceNowTickets > POST request for endpoint /api/bulkCreateServiceNowTickets ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/bulkCreateServiceNowTickets":{"post":{"summary":"POST request for endpoint /api/bulkCreateServiceNowTickets","operationId":"/api/bulkCreateServiceNowTickets-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["testingIssuesIdList","tableName"],"properties":{"testingIssuesIdList":{"type":"array","items":{"type":"object"}},"tableName":{"type":"string"},"aktoDashboardHostName":{"type":"string"}}}}}},"responses":{"200":{"description":"ServiceNow tickets created","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## Microsoft Defender
#APIDescription
1POST /api/addMicrosoftDefenderIntegrationAdds or updates the Microsoft Defender for Endpoint integration configuration.
2POST /api/removeMicrosoftDefenderIntegrationRemoves the Microsoft Defender for Endpoint integration configuration.
3POST /api/uploadDefenderScriptUploads a script to the Microsoft Defender Live Response library.
4POST /api/runDefenderKqlQueryExecutes a KQL (Kusto Query Language) query against Microsoft Defender data.
5POST /api/runDefenderLiveResponseRuns a Live Response session or script on a device via Microsoft Defender.
6POST /api/ingestDefenderKqlResultsIngests and processes KQL query results from Microsoft Defender into Akto.
## POST /api/addMicrosoftDefenderIntegration > POST request for endpoint /api/addMicrosoftDefenderIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addMicrosoftDefenderIntegration":{"post":{"summary":"POST request for endpoint /api/addMicrosoftDefenderIntegration","operationId":"/api/addMicrosoftDefenderIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["tenantId","clientId","clientSecret","dataIngestionUrl"],"properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"dataIngestionUrl":{"type":"string"},"recurringIntervalSeconds":{"type":"integer","description":"Polling interval for Advanced Hunting jobs (default: 3600)"}}}}}},"responses":{"200":{"description":"Integration saved; recurring job created or updated","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — missing required fields"}}}}}} ``` ## POST /api/removeMicrosoftDefenderIntegration > POST request for endpoint /api/removeMicrosoftDefenderIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/removeMicrosoftDefenderIntegration":{"post":{"summary":"POST request for endpoint /api/removeMicrosoftDefenderIntegration","operationId":"/api/removeMicrosoftDefenderIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Integration removed","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/uploadDefenderScript > POST request for endpoint /api/uploadDefenderScript ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/uploadDefenderScript":{"post":{"summary":"POST request for endpoint /api/uploadDefenderScript","operationId":"/api/uploadDefenderScript-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["scriptContent","scriptName"],"properties":{"scriptContent":{"type":"string","description":"Script content (PowerShell or Bash)"},"scriptName":{"type":"string"}}}}}},"responses":{"200":{"description":"Script uploaded to Defender library","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/runDefenderKqlQuery > POST request for endpoint /api/runDefenderKqlQuery ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/runDefenderKqlQuery":{"post":{"summary":"POST request for endpoint /api/runDefenderKqlQuery","operationId":"/api/runDefenderKqlQuery-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["kqlQuery"],"properties":{"kqlQuery":{"type":"string"},"agentName":{"type":"string"}}}}}},"responses":{"200":{"description":"KQL query results returned","content":{"application/json":{"schema":{"type":"object","properties":{"kqlResults":{"type":"array","description":"Query result rows; column names vary by query","items":{"type":"object"}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — integration not configured or KQL error"}}}}}} ``` ## POST /api/runDefenderLiveResponse > POST request for endpoint /api/runDefenderLiveResponse ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/runDefenderLiveResponse":{"post":{"summary":"POST request for endpoint /api/runDefenderLiveResponse","operationId":"/api/runDefenderLiveResponse-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["deviceIds","scriptName"],"properties":{"deviceIds":{"type":"array","items":{"type":"string"}},"scriptName":{"type":"string","description":"Script name in the Defender library"},"scriptParameters":{"type":"string","description":"Input parameters passed to the script"}}}}}},"responses":{"200":{"description":"Live response completed","content":{"application/json":{"schema":{"type":"object","properties":{"liveResponseResults":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"string"},"status":{"type":"string"},"output":{"type":"string"}}}}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/ingestDefenderKqlResults > POST request for endpoint /api/ingestDefenderKqlResults ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/ingestDefenderKqlResults":{"post":{"summary":"POST request for endpoint /api/ingestDefenderKqlResults","operationId":"/api/ingestDefenderKqlResults-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["kqlResults","agentName"],"properties":{"kqlResults":{"type":"array","items":{"type":"object"},"description":"Array of KQL result row objects to ingest"},"agentName":{"type":"string"}}}}}},"responses":{"200":{"description":"KQL results ingested","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## SentinelOne
#APIDescription
1POST /api/addSentinelOneIntegrationAdds or updates the SentinelOne integration configuration.
2POST /api/removeSentinelOneIntegrationRemoves the SentinelOne integration configuration.
3POST /api/executeSentinelOneRemoteScriptExecutes a remote script on a SentinelOne-enrolled endpoint.
## POST /api/addSentinelOneIntegration > POST request for endpoint /api/addSentinelOneIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addSentinelOneIntegration":{"post":{"summary":"POST request for endpoint /api/addSentinelOneIntegration","operationId":"/api/addSentinelOneIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["consoleUrl","dataIngestionUrl"],"properties":{"consoleUrl":{"type":"string"},"dataIngestionUrl":{"type":"string"},"apiToken":{"type":"string","description":"SentinelOne API token. Required on first save; omit to keep the existing token."},"recurringIntervalSeconds":{"type":"integer","description":"Agent data collection interval (default: 3600)"}}}}}},"responses":{"200":{"description":"Integration saved; recurring job created/updated","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — missing required fields","content":{"application/json":{"schema":{"type":"object","properties":{"actionErrors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## POST /api/removeSentinelOneIntegration > POST request for endpoint /api/removeSentinelOneIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/removeSentinelOneIntegration":{"post":{"summary":"POST request for endpoint /api/removeSentinelOneIntegration","operationId":"/api/removeSentinelOneIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Integration removed","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/executeSentinelOneRemoteScript > POST request for endpoint /api/executeSentinelOneRemoteScript ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/executeSentinelOneRemoteScript":{"post":{"summary":"POST request for endpoint /api/executeSentinelOneRemoteScript","operationId":"/api/executeSentinelOneRemoteScript-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["scriptId","executeAgentIds"],"properties":{"scriptId":{"type":"string","description":"Script ID from the SentinelOne script library"},"executeAgentIds":{"type":"array","items":{"type":"string"}},"executeTaskDescription":{"type":"string"},"executeInputParams":{"type":"string","description":"Space-separated key=value environment variable pairs"}}}}}},"responses":{"200":{"description":"Script execution initiated","content":{"application/json":{"schema":{"type":"object","properties":{"parentTaskId":{"type":"string","description":"Use with getSentinelOneScriptTaskStatus to poll for completion"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — scriptId or agentIds missing","content":{"application/json":{"schema":{"type":"object","properties":{"actionErrors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## Generic Integrations
#APIDescription
1POST /api/testIntegrationTests a configured integration by sending a test payload to verify connectivity.
2POST /api/addIntegrationAdds or updates a generic integration configuration by type.
3POST /api/markConnectionAsSkippedMarks an integration connection as skipped during setup or onboarding.
## POST /api/testIntegration > POST request for endpoint /api/testIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/testIntegration":{"post":{"summary":"POST request for endpoint /api/testIntegration","operationId":"/api/testIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["baseUrl","projId","userEmail","apiToken","jiraType"],"properties":{"baseUrl":{"type":"string"},"projId":{"type":"string","description":"Comma-separated project keys"},"userEmail":{"type":"string"},"apiToken":{"type":"string"},"jiraType":{"type":"string","enum":["CLOUD","DATA_CENTER"]}}}}}},"responses":{"200":{"description":"Credentials valid; issue types resolved","content":{"application/json":{"schema":{"type":"object","properties":{"projectAndIssueMap":{"type":"object","description":"Map of project key to resolved issue type list"}}}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — invalid credentials or project not found"}}}}}} ``` ## POST /api/addIntegration > POST request for endpoint /api/addIntegration ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addIntegration":{"post":{"summary":"POST request for endpoint /api/addIntegration","operationId":"/api/addIntegration-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["baseUrl","projId","userEmail","apiToken","jiraType"],"properties":{"baseUrl":{"type":"string"},"projId":{"type":"string"},"userEmail":{"type":"string"},"apiToken":{"type":"string"},"issueType":{"type":"string"},"jiraType":{"type":"string","enum":["CLOUD","DATA_CENTER"]},"projectAndIssueMap":{"type":"object","description":"Map of project key to issue type list (from testIntegration response)"},"projectMappings":{"type":"object","description":"Map of project key to mapping settings"}}}}}},"responses":{"200":{"description":"Jira integration saved","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/markConnectionAsSkipped > POST request for endpoint /api/markConnectionAsSkipped ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/markConnectionAsSkipped":{"post":{"summary":"POST request for endpoint /api/markConnectionAsSkipped","operationId":"/api/markConnectionAsSkipped-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["connectionSkipped"],"properties":{"connectionSkipped":{"type":"string","description":"Connection type to mark as skipped","enum":["AUTOMATED_TRAFFIC","GITHUB_SSO","SLACK_ALERTS","CI_CD_INTEGRATIONS","INVITE_MEMBERS"]}}}}}},"responses":{"200":{"description":"Connection marked as skipped","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — connectionSkipped is null"}}}}}} ``` ## Slack Webhooks
#APIDescription
1POST /api/addSlackWebhookAdds a new Slack webhook integration for alert and notification delivery.
2POST /api/deleteSlackWebhookRemoves a configured Slack webhook integration.
## POST /api/addSlackWebhook > POST request for endpoint /api/addSlackWebhook ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addSlackWebhook":{"post":{"summary":"POST request for endpoint /api/addSlackWebhook","operationId":"/api/addSlackWebhook-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["webhookUrl","webhookName"],"properties":{"webhookUrl":{"type":"string"},"webhookName":{"type":"string"},"dashboardUrl":{"type":"string"},"frequencyInSeconds":{"type":"integer"}}}}}},"responses":{"200":{"description":"Slack webhook added","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable"}}}}}} ``` ## POST /api/deleteSlackWebhook > POST request for endpoint /api/deleteSlackWebhook ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/deleteSlackWebhook":{"post":{"summary":"POST request for endpoint /api/deleteSlackWebhook","operationId":"/api/deleteSlackWebhook-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["webhookName"],"properties":{"webhookName":{"type":"string"}}}}}},"responses":{"200":{"description":"Slack webhook deleted","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"}}}}}} ``` ## Custom Webhooks
#APIDescription
1POST /api/addCustomWebhookAdds a new custom webhook integration for event notifications.
2POST /api/checkWebhookTests a custom webhook by sending a test request to verify connectivity and response.
3POST /api/updateCustomWebhookUpdates an existing custom webhook integration configuration.
## POST /api/addCustomWebhook > POST request for endpoint /api/addCustomWebhook ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addCustomWebhook":{"post":{"summary":"POST request for endpoint /api/addCustomWebhook","operationId":"/api/addCustomWebhook-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["webhookName","url","method"],"properties":{"webhookName":{"type":"string"},"url":{"type":"string"},"method":{"type":"string","enum":["GET","POST"]},"headerString":{"type":"string","description":"JSON string of headers to include"},"queryParams":{"type":"string"},"body":{"type":"string","description":"JSON template for the webhook payload"},"frequencyInSeconds":{"type":"integer"},"activeStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"selectedWebhookOptions":{"type":"array","items":{"type":"string"}},"newEndpointCollections":{"type":"array","items":{"type":"string"}},"newSensitiveEndpointCollections":{"type":"array","items":{"type":"string"}},"batchSize":{"type":"integer"},"sendInstantly":{"type":"boolean"},"webhookType":{"type":"string"}}}}}},"responses":{"200":{"description":"Custom webhook created","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — validation failed (invalid URL, method, etc.)"}}}}}} ``` ## POST /api/checkWebhook > POST request for endpoint /api/checkWebhook ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/checkWebhook":{"post":{"summary":"POST request for endpoint /api/checkWebhook","operationId":"/api/checkWebhook-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["webhookName"],"properties":{"webhookName":{"type":"string"}}}}}},"responses":{"200":{"description":"Existence check result","content":{"application/json":{"schema":{"type":"object","properties":{"webhookPresent":{"type":"boolean"}}}}}},"403":{"description":"Forbidden"}}}}}} ``` ## POST /api/updateCustomWebhook > POST request for endpoint /api/updateCustomWebhook ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/updateCustomWebhook":{"post":{"summary":"POST request for endpoint /api/updateCustomWebhook","operationId":"/api/updateCustomWebhook-POST","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["id","webhookName","url","method"],"properties":{"id":{"type":"integer","description":"Existing custom webhook ID"},"webhookName":{"type":"string"},"url":{"type":"string"},"method":{"type":"string","enum":["GET","POST"]},"headerString":{"type":"string"},"queryParams":{"type":"string"},"body":{"type":"string"},"frequencyInSeconds":{"type":"integer"},"activeStatus":{"type":"string","enum":["ACTIVE","INACTIVE"]},"selectedWebhookOptions":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Webhook updated","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable — validation failed"}}}}}} ```