Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fetch Data

Table of Contents

Jira

#
API
Description

1

POST /api/jira/fetchProjectStatuses

Fetches all issue statuses for a Jira project, used to configure bi-directional sync status mappings.

2

POST /api/jira/fetchPriorities

Fetches available priority levels from the configured Jira instance.

3

POST /api/jira/fetchAvailableFieldsForMapping

Fetches Jira issue fields available for priority field mapping for a given project and issue type.

4

POST /api/jira/fetchFieldValues

Fetches allowed values for a specific Jira field in a given project.

5

POST /api/jira/fetchPriorityFieldMapping

Retrieves the saved Akto severity to Jira field value mapping for a project.

6

POST /api/fetchCreateJiraIssueFieldMetaData

Fetches field metadata required to create a Jira issue for a given project and issue type.

POST request for endpoint /api/jira/fetchProjectStatuses

post
Body
projIdstringRequiredExample: SCRUM
Responses
200

Project statuses retrieved

application/json
projectMappingsobjectOptionalExample: {"SCRUM":{"statuses":[{"id":"10000","name":"To Do","statusCategory":"new"},{"id":"10001","name":"In Progress","statusCategory":"indeterminate"},{"id":"10002","name":"Done","statusCategory":"done"}]}}
post/api/jira/fetchProjectStatuses
POST /api/jira/fetchProjectStatuses HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "projId": "SCRUM"
}
{
  "projectMappings": {
    "SCRUM": {
      "statuses": [
        {
          "id": "10000",
          "name": "To Do",
          "statusCategory": "new"
        },
        {
          "id": "10001",
          "name": "In Progress",
          "statusCategory": "indeterminate"
        },
        {
          "id": "10002",
          "name": "Done",
          "statusCategory": "done"
        }
      ]
    }
  }
}

POST request for endpoint /api/jira/fetchPriorities

post
Body
objectOptional
Responses
200

Jira priorities retrieved

application/json
post/api/jira/fetchPriorities
POST /api/jira/fetchPriorities HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "jiraPriorities": [
    {
      "id": "1",
      "name": "Highest"
    },
    {
      "id": "2",
      "name": "High"
    },
    {
      "id": "3",
      "name": "Medium"
    },
    {
      "id": "4",
      "name": "Low"
    },
    {
      "id": "5",
      "name": "Lowest"
    }
  ]
}

POST request for endpoint /api/jira/fetchAvailableFieldsForMapping

post
Body
projIdstringRequiredExample: SCRUM
issueTypestringRequiredExample: Bug
Responses
200

Available fields retrieved

application/json
post/api/jira/fetchAvailableFieldsForMapping
POST /api/jira/fetchAvailableFieldsForMapping HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "projId": "SCRUM",
  "issueType": "Bug"
}
{
  "fields": [
    {
      "id": "priority",
      "name": "Priority",
      "type": "priority"
    }
  ]
}

POST request for endpoint /api/jira/fetchFieldValues

post
Body
projIdstringRequiredExample: SCRUM
fieldIdstringRequiredExample: priority
Responses
200

Field values retrieved

application/json
post/api/jira/fetchFieldValues
POST /api/jira/fetchFieldValues HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "projId": "SCRUM",
  "fieldId": "priority"
}
{
  "fieldValues": [
    {
      "id": "1",
      "value": "Highest"
    }
  ]
}

POST request for endpoint /api/jira/fetchPriorityFieldMapping

post
Body
projIdstringRequiredExample: SCRUM
Responses
200

Priority mapping retrieved

application/json
post/api/jira/fetchPriorityFieldMapping
POST /api/jira/fetchPriorityFieldMapping HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "projId": "SCRUM"
}
{
  "priorityMapping": {
    "fieldId": "priority",
    "fieldValuesMap": {
      "HIGH": "1",
      "MEDIUM": "3",
      "LOW": "5"
    }
  }
}

POST request for endpoint /api/fetchCreateJiraIssueFieldMetaData

post
Body
projIdstringRequiredExample: SCRUM
issueTypestringRequiredExample: Bug
Responses
200

Field metadata retrieved

application/json
jiraMetaDataobjectOptional

Field metadata for issue creation — required fields, field types, allowed values

Example: {"projId":"SCRUM","issueType":"Bug","fields":[{"id":"summary","name":"Summary","required":true},{"id":"priority","name":"Priority","required":false}]}
post/api/fetchCreateJiraIssueFieldMetaData
POST /api/fetchCreateJiraIssueFieldMetaData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "projId": "SCRUM",
  "issueType": "Bug"
}
{
  "jiraMetaData": {
    "projId": "SCRUM",
    "issueType": "Bug",
    "fields": [
      {
        "id": "summary",
        "name": "Summary",
        "required": true
      },
      {
        "id": "priority",
        "name": "Priority",
        "required": false
      }
    ]
  }
}

Azure Boards

#
API
Description

1

POST /api/fetchAzureBoardsIntegration

Fetches the current Azure Boards integration configuration and status.

2

POST /api/fetchCreateABWorkItemFieldMetaData

Fetches field metadata required to create an Azure Boards work item for a given project and issue type.

POST request for endpoint /api/fetchAzureBoardsIntegration

post
Body
objectOptional
Responses
200

Azure Boards integration retrieved

application/json
post/api/fetchAzureBoardsIntegration
POST /api/fetchAzureBoardsIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "azureBoardsIntegration": {
    "azureBoardsBaseUrl": "https://dev.azure.com",
    "organization": "example-corp",
    "projectList": [
      "AktoSecurity",
      "InfraTeam"
    ]
  }
}

POST request for endpoint /api/fetchCreateABWorkItemFieldMetaData

post
Body
projectNamestringRequiredExample: AktoSecurity
Responses
200

Field metadata retrieved

application/json
post/api/fetchCreateABWorkItemFieldMetaData
POST /api/fetchCreateABWorkItemFieldMetaData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "projectName": "AktoSecurity"
}
{
  "fields": [
    {
      "referenceName": "System.Title",
      "name": "Title",
      "type": "string"
    }
  ]
}

Datadog

#
API
Description

1

POST /api/fetchDatadogIntegration

Fetches the current Datadog integration configuration and status.

POST request for endpoint /api/fetchDatadogIntegration

post
Body
objectOptional
Responses
200

Datadog integration retrieved

application/json
post/api/fetchDatadogIntegration
POST /api/fetchDatadogIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "datadogForwarderConfig": {
    "datadogSite": "datadoghq.com",
    "enabled": true
  }
}

Splunk

#
API
Description

1

POST /api/fetchSplunkIntegration

Fetches the current Splunk SIEM integration configuration and status.

POST request for endpoint /api/fetchSplunkIntegration

post
Body
objectOptional
Responses
200

Splunk integration retrieved

application/json
post/api/fetchSplunkIntegration
POST /api/fetchSplunkIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "splunkSiemConfig": {
    "splunkUrl": "http://splunk.example.com:8088/services/collector"
  }
}

Azure Data Explorer (ADX)

#
API
Description

1

POST /api/fetchAdxIntegration

Fetches the current Azure Data Explorer integration configuration and status.

2

POST /api/getAdxExportStatus

Retrieves the current export status and progress for the Azure Data Explorer integration.

POST request for endpoint /api/fetchAdxIntegration

post
Body
objectOptional
Responses
200

ADX integration retrieved

application/json
post/api/fetchAdxIntegration
POST /api/fetchAdxIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "adxIntegration": {
    "clusterEndpoint": "https://akto-cluster.eastus.kusto.windows.net",
    "databaseName": "AktoThreatDB",
    "tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "applicationClientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  }
}

POST request for endpoint /api/getAdxExportStatus

post
Body
objectOptional
Responses
200

Export status retrieved

application/json
exportSuccessbooleanOptionalExample: true
exportMessagestringOptionalExample: Export under processing
exportedCountintegerOptionalExample: 0
post/api/getAdxExportStatus
POST /api/getAdxExportStatus HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "exportSuccess": true,
  "exportMessage": "Export under processing",
  "exportedCount": 0
}

DevRev

#
API
Description

1

POST /api/fetchDevRevIntegration

Fetches the current DevRev integration configuration and status.

2

POST /api/fetchDevRevParts

Retrieves available DevRev parts/components for ticket creation and linking.

POST request for endpoint /api/fetchDevRevIntegration

post
Body
objectOptional
Responses
200

DevRev integration retrieved

application/json
post/api/fetchDevRevIntegration
POST /api/fetchDevRevIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "devrevIntegration": {
    "orgUrl": "https://app.devrev.ai/example-org"
  }
}

POST request for endpoint /api/fetchDevRevParts

post
Body
objectOptional
Responses
200

DevRev parts retrieved

application/json
partsIdToNameMapobjectOptional

Map of DevRev part ID to display name

Example: {"PROD-001":"Security Platform","PROD-002":"API Gateway"}
partTypesstring[]OptionalExample: ["issue","ticket","feature"]
post/api/fetchDevRevParts
POST /api/fetchDevRevParts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "partsIdToNameMap": {
    "PROD-001": "Security Platform",
    "PROD-002": "API Gateway"
  },
  "partTypes": [
    "issue",
    "ticket",
    "feature"
  ]
}

ServiceNow

#
API
Description

1

POST /api/fetchServiceNowIntegration

Fetches the current ServiceNow integration configuration and status.

2

POST /api/fetchServiceNowTables

Retrieves available ServiceNow tables for ticket creation configuration.

POST request for endpoint /api/fetchServiceNowIntegration

post
Body
objectOptional
Responses
200

ServiceNow integration retrieved

application/json
post/api/fetchServiceNowIntegration
POST /api/fetchServiceNowIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "serviceNowIntegration": {
    "instanceUrl": "https://example.service-now.com",
    "tableNames": [
      "incident",
      "problem"
    ]
  }
}

POST request for endpoint /api/fetchServiceNowTables

post
Body
instanceUrlstringRequiredExample: https://example.service-now.com
clientIdstringRequiredExample: c3d4e5f6a7b8c9d0
clientSecretstringRequiredExample: [REDACTED_SNOW_CLIENT_SECRET]
Responses
200

ServiceNow tables retrieved

application/json
post/api/fetchServiceNowTables
POST /api/fetchServiceNowTables HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "instanceUrl": "https://example.service-now.com",
  "clientId": "c3d4e5f6a7b8c9d0",
  "clientSecret": "[REDACTED_SNOW_CLIENT_SECRET]"
}
{
  "tables": [
    {
      "name": "incident",
      "label": "Incident"
    }
  ]
}

Microsoft Defender

#
API
Description

1

POST /api/fetchMicrosoftDefenderIntegration

Fetches the current Microsoft Defender for Endpoint integration configuration and status.

2

POST /api/fetchDefenderDevices

Retrieves devices enrolled in Microsoft Defender for Endpoint.

3

POST /api/listDefenderLibraryScripts

Lists available scripts from the Microsoft Defender Live Response library.

POST request for endpoint /api/fetchMicrosoftDefenderIntegration

post
Body
objectOptional
Responses
200

Integration retrieved

application/json
post/api/fetchMicrosoftDefenderIntegration
POST /api/fetchMicrosoftDefenderIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "microsoftDefenderIntegration": {
    "tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "clientId": "d4e5f6a7-b8c9-0123-def0-123456789012",
    "dataIngestionUrl": "https://akto-ingestion.example.com"
  }
}

POST request for endpoint /api/fetchDefenderDevices

post
Body
objectOptional
Responses
200

Devices retrieved

application/json
post/api/fetchDefenderDevices
POST /api/fetchDefenderDevices HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "devices": [
    {
      "id": "a1b2c3d4e5f6789012345678901234567890abcd",
      "computerName": "prod-api-server-01",
      "osName": "Linux",
      "lastActiveDate": "2024-01-15T14:30:00Z",
      "siteId": "site-001"
    }
  ]
}

POST request for endpoint /api/listDefenderLibraryScripts

post
Body
objectOptional
Responses
200

Library scripts retrieved

application/json
post/api/listDefenderLibraryScripts
POST /api/listDefenderLibraryScripts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "libraryScripts": [
    {
      "id": "script-uuid-001",
      "fileName": "akto-guardrail-check.sh",
      "description": "Akto guardrail installation script",
      "createdBy": "admin@example.com",
      "creationTime": "2024-01-15T10:00:00Z"
    }
  ]
}

SentinelOne

#
API
Description

1

POST /api/fetchSentinelOneIntegration

Fetches the current SentinelOne integration configuration and status.

2

POST /api/fetchSentinelOneAgents

Retrieves agents enrolled in SentinelOne for endpoint management.

3

POST /api/getSentinelOneScriptTaskStatus

Gets the execution status of a remote script task run via SentinelOne.

POST request for endpoint /api/fetchSentinelOneIntegration

post
Body
objectOptional
Responses
200

SentinelOne integration retrieved

application/json
post/api/fetchSentinelOneIntegration
POST /api/fetchSentinelOneIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "sentinelOneIntegration": {
    "consoleUrl": "https://example.sentinelone.net",
    "dataIngestionUrl": "https://akto-ingestion.example.com",
    "guardrailType": [
      "cursor-hooks"
    ],
    "guardrailTargetMode": "all",
    "guardrailStatus": "completed"
  }
}

POST request for endpoint /api/fetchSentinelOneAgents

post
Body
objectOptional
Responses
200

Agents retrieved

application/json
post/api/fetchSentinelOneAgents
POST /api/fetchSentinelOneAgents HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "agents": [
    {
      "id": "1234567890123456789",
      "computerName": "prod-api-server-01",
      "osName": "Linux Ubuntu 22.04",
      "lastActiveDate": "2024-01-15T14:30:00.000Z",
      "siteId": "9876543210987654321"
    }
  ]
}

POST request for endpoint /api/getSentinelOneScriptTaskStatus

post
Body
parentTaskIdstringRequired

Parent task ID returned by executeSentinelOneRemoteScript

Example: task-uuid-abc123def456
Responses
200

Task status retrieved

application/json
post/api/getSentinelOneScriptTaskStatus
POST /api/getSentinelOneScriptTaskStatus HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "parentTaskId": "task-uuid-abc123def456"
}
{
  "remoteScripts": [
    {
      "agentComputerName": "prod-api-server-01",
      "status": "completed",
      "detailedStatus": "Script executed successfully",
      "updatedAt": "2024-01-15T14:35:00.000Z"
    }
  ]
}

Generic Integrations

#
API
Description

1

POST /api/fetchIntegration

Fetches configuration and status of a generic integration by type.

2

POST /api/getIntegratedConnectionsInfo

Retrieves info about all currently connected and active integrations.

POST request for endpoint /api/fetchIntegration

post
Body
objectOptional
Responses
200

Jira integration retrieved

application/json
post/api/fetchIntegration
POST /api/fetchIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "jiraIntegration": {
    "baseUrl": "https://example-org.atlassian.net",
    "userEmail": "admin@example.com",
    "projectIdsMap": {
      "SCRUM": [
        {
          "issueId": "10001",
          "issueType": "Bug"
        }
      ]
    },
    "projectMappings": {
      "SCRUM": {
        "biDirectionalSyncSettings": {
          "enabled": false
        },
        "statuses": []
      }
    },
    "createdTs": 1766398064,
    "updatedTs": 1766398064
  }
}

POST request for endpoint /api/getIntegratedConnectionsInfo

post
Body
objectOptional
Responses
200

Connection info retrieved

application/json
post/api/getIntegratedConnectionsInfo
POST /api/getIntegratedConnectionsInfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "integratedConnectionsInfo": {
    "AUTOMATED_TRAFFIC": {
      "timestamp": 1766398064,
      "skipped": false
    },
    "GITHUB_SSO": {
      "timestamp": 0,
      "skipped": false
    },
    "SLACK_ALERTS": {
      "timestamp": 0,
      "skipped": true
    },
    "CI_CD_INTEGRATIONS": {
      "timestamp": 0,
      "skipped": false
    },
    "INVITE_MEMBERS": {
      "timestamp": 1766311200,
      "skipped": false
    }
  }
}

Slack Webhooks

#
API
Description

1

POST /api/fetchSlackWebhooks

Retrieves all configured Slack webhook integrations for the account.

POST request for endpoint /api/fetchSlackWebhooks

post
Body
objectOptional
Responses
200

Slack webhooks retrieved

application/json
post/api/fetchSlackWebhooks
POST /api/fetchSlackWebhooks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "slackWebhooks": [
    {
      "webhookUrl": "https://hooks.slack.com/services/[REDACTED_SLACK_WEBHOOK_PATH]",
      "webhookName": "security-alerts",
      "frequencyInSeconds": 3600
    }
  ]
}

Custom Webhooks

#
API
Description

1

POST /api/fetchCustomWebhooks

Retrieves all configured custom webhook integrations for the account.

2

POST /api/fetchLatestWebhookResult

Fetches the result of the most recent webhook invocation for debugging and verification.

POST request for endpoint /api/fetchCustomWebhooks

post
Body
objectOptional
Responses
200

Custom webhooks retrieved

application/json
post/api/fetchCustomWebhooks
POST /api/fetchCustomWebhooks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "customWebhooks": [
    {
      "id": 7,
      "webhookName": "new-endpoint-notifier",
      "url": "https://hooks.example.com/akto-events",
      "method": "POST",
      "frequencyInSeconds": 3600,
      "activeStatus": "ACTIVE",
      "selectedWebhookOptions": [
        "NEW_ENDPOINT"
      ]
    }
  ]
}

POST request for endpoint /api/fetchLatestWebhookResult

post
Body
customWebhookIdintegerRequiredExample: 7
Responses
200

Latest webhook result retrieved

application/json
post/api/fetchLatestWebhookResult
POST /api/fetchLatestWebhookResult HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "customWebhookId": 7
}
{
  "customWebhookResult": {
    "webhookId": 7,
    "statusCode": 200,
    "message": "OK",
    "timestamp": 1766398064
  }
}
PreviousIntegrationNextModify Data

Last updated