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

Fetch Data

Table of Contents

Agent & MCP

#
API
Description

1

POST /api/getAllCollectionsBasic

Fetch a lightweight list of all agentic collections with only basic metadata. Useful for quick lookups or dropdowns.

2

POST /api/getAllCollections

Retrieve the complete list of all agentic collections with detailed information.

3

POST /api/getAllUsersCollections

Fetch all agentic collections accessible to the current user.

4

POST /api/getCoverageInfoForCollections

Get scan coverage data for each collection (e.g., how many Agentic components are scanned vs. unscanned). Used to track which agentic components are covered by scans.

5

POST /api/getSeverityInfoForCollections

Retrieve aggregated severity information (High, Medium, Low) across agentic collections.

6

POST /api/getSeveritiesCountPerCollection

Get the count of issues grouped by severity for each collection.

7

POST /api/getLastSeenTrafficInfoForCollections

Fetch last seen traffic timestamps for each collection, helping track activity recency.

8

POST /api/getSensitiveInfoForCollections

Retrieve sensitive data findings per collection (e.g., PII, secrets).

9

POST /api/getRiskScoreInfo

Get risk scores calculated for agentic collections, based on guardrails and sensitive data exposure.

10

POST /api/fetchCollectionWiseApiEndpoints

Fetch all Agentic components belonging to a specific collection.

11

POST /api/fetchApiInfosForCollection

Retrieve detailed agentic component information for a given collection (method, path, params, etc.).

12

POST /api/fetchEndpointsCount

Get a count of Agentic components per collection.

13

POST /api/fetchApiCallStats

Retrieve traffic statistics such as call counts, trends, and usage metrics per agentic component call.

14

POST /api/fetchIpLevelApiCallStats

Get agentic component call stats broken down by IP, useful for identifying abusive clients or usage patterns.

15

POST /api/fetchSampleData

Fetch sample Agentic Request/Agentic Response payloads observed for a given agentic component, used for scanning or schema generation.

16

POST /api/generateOpenApiFile

Generate an OpenAPI (Swagger) specification file from discovered Agentic Component data.

17

POST /api/fetchAllUrlsAndMethods

Fetch all unique Agentic components and HTTP methods in a collection.

18

POST /api/fetchNewEndpointsTrendForHostCollections

Get trend of newly discovered Agentic components for host-based collections (for Agentic dashboard).

19

POST /api/fetchNewEndpointsTrendForNonHostCollections

Get trend of newly discovered Agentic components for non-host collections (for Agentic dashboard).

20

POST /api/fetchAPICollection

Fetch Agentic Component collection details and metadata.

21

POST /api/fetchChanges

Retrieve recent Agentic Components in Agentic Collections.

22

POST /api/fetchCustomAuthTypes

Fetch custom authentication types configured in the system.

23

POST /api/fetchDataTypeNames

Retrieve names of all configured data types.

24

POST /api/fetchDataTypes

Fetch detailed information about data types.

25

POST /api/fetchEndpointTrafficData

Get traffic and usage data for Agentic Components.

26

POST /api/fetchNewParametersTrend

Retrieve trends of newly discovered Agentic Parameters.

27

POST /api/fetchSensitiveParamsForEndpoints

Fetch Agentic Parameters identified as sensitive for Agentic components.

28

POST /api/fetchTagConfigs

Retrieve tag configurations for Agentic Component organization.

29

POST /api/loadRecentEndpoints

Load recently discovered or modified Agentic components.

30

POST /api/checkAgentRunModule

Checks if an agent process is currently running on any module.

31

POST /api/fetchMcpAuditInfoByCollection

Fetches MCP audit information for a specific Agentic Collection by extracting the MCP server name from hostname.

32

POST /api/fetchMcpToolsApiCalls

Fetches Agentic Component calls made by MCP tools in a collection, grouping them by parent tool names.

33

POST /api/getAgentLogs

Fetches agent logs for a specific agent within a time range, sorted by timestamp (newest first), capped at 10,000 logs.

34

POST /api/getAgentModels

Fetches all configured AI models for agents, excluding sensitive parameter data.

35

POST /api/getAllAgentRunningDetails

Fetches complete agent run and all its subprocesses for reboot/recovery scenarios.

36

POST /api/getAllAgentRuns

Fetches all currently running agent runs, with special handling for discovery agents.

37

POST /api/getAllAgentRunsObject

Fetches all agent runs (any state) for a specific agent type.

38

POST /api/getMcpServersByAgent

Retrieves MCP servers configured for a specific agent or device, including server name, URL, and last seen timestamp.

39

POST /api/getMcpdata

Fetches MCP-related metrics and data based on filter type, including Agentic Component counts, audit alerts, and traffic analysis.

40

POST /api/getMemberAgents

Returns all available agent types/modules from the Agent enum.

41

POST /api/receiveDataFromAgent

Receives various types of data updates from running agents, handling logs, state changes, HAR data, and Agentic Component dependencies.

42

POST /api/fetchAllResponsesForApiCollectionOrdered

Fetches sample Agentic Response data for Agentic Components in a collection with pagination support, ordered by Agentic Component creation time.

43

POST /api/getAllSubProcesses

Fetches all subprocesses for an agent run, with special handling for discovery agents.

44

POST /api/getFileForDiscovery

Retrieves compressed file content for discovery agent, validating it's within allowed size.

45

POST /api/getSubProcess

Fetches details of a specific subprocess attempt.

46

GET /api/inventory/{collectionId}/openapi

Retrieve OpenAPI specification for a specific Agentic Collection.

47

POST /api/getAPICatalog

Retrieve the complete Agentic Component catalog with all discovered Agentic Components.

48

POST /api/fetchCollections

Fetch all available Agentic Collections.

49

POST /api/getCollection

Get details of a specific Agentic Collection.

50

POST /api/fetchIconsForHostnames

Fetch icons for given hostnames.

51

POST /api/getApiSequences

Get Agentic Component call sequences for a collection.

52

POST /api/getSwaggerDependencies

Get Swagger/OpenAPI dependencies for Agentic Components.

53

POST /api/getCountForHostnameDeactivatedCollections

Get count of deactivated agentic collections per hostname.

54

POST /api/getCountForUningestedApis

Get count of unintegrated Agentic Components.

55

POST /api/fetchUningestedApis

Fetch all unintegrated Agentic Components.

56

POST /api/getSensitiveAndUnauthenticatedValue

Get Sensitive in Response fields and unauthenticated Agentic Components.

57

POST /api/getHighRiskThirdPartyValue

Get high-risk third-party Agentic Components.

58

POST /api/getShadowApis

Get shadow/unmanaged Agentic Components.

59

POST /api/fetchActionItemsApiInfo

Fetch action items related to Agentic Component information.

60

POST /api/fetchAllUnauthenticatedApis

Fetch all unauthenticated Agentic Components.

61

POST /api/getCustomerEndpoints

Get customer Agentic Components statistics.

62

POST /api/getDeMergedApis

Get list of de-merged Agentic Components.

63

POST /api/fetchNonStandardHeaderKeys

Fetch non-standard headers found in Agentic Components.

64

POST /api/getUniqueHostsTested

Get count of unique hosts that have been scanned.

65

POST /api/fetchCountMapOfApis

Fetch count map of Agentic Components by data type.

POST request for endpoint /api/getAllCollectionsBasic

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

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

{}
200

description

{
  "apiCollections": [
    {
      "id": 1,
      "name": "Production APIs",
      "displayName": "Production APIs",
      "hostName": "null",
      "urlsCount": 45,
      "createdTs": 1679462413,
      "deactivated": false,
      "redacted": false,
      "type": "API_COLLECTION"
    }
  ]
}

POST request for endpoint /api/getSeverityInfoForCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

severityInfoobjectOptionalExample: {"1":{"CRITICAL":5,"HIGH":12,"MEDIUM":23,"LOW":45}}
post/api/getSeverityInfoForCollections
POST /api/getSeverityInfoForCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "severityInfo": {
    "1": {
      "CRITICAL": 5,
      "HIGH": 12,
      "MEDIUM": 23,
      "LOW": 45
    }
  }
}

POST request for endpoint /api/getLastSeenTrafficInfoForCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

lastTrafficSeenMapobjectOptionalExample: {"1":1712102400,"2":1712089000}
post/api/getLastSeenTrafficInfoForCollections
POST /api/getLastSeenTrafficInfoForCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "lastTrafficSeenMap": {
    "1": 1712102400,
    "2": 1712089000
  }
}

POST request for endpoint /api/getSensitiveInfoForCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

typestringOptionalExample: topSensitive
Responses
200

description

application/json

Sample description

sensitiveUrlsInResponseinteger · int32OptionalExample: 10
sensitiveSubtypesInCollectionobjectOptional
sensitiveSubtypesInUrlobject[]Optional
post/api/getSensitiveInfoForCollections
POST /api/getSensitiveInfoForCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "type": "topSensitive"
}
200

description

{
  "sensitiveUrlsInResponse": 10,
  "sensitiveSubtypesInCollection": {},
  "sensitiveSubtypesInUrl": [
    {}
  ]
}

POST request for endpoint /api/getRiskScoreInfo

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

riskScoreOfCollectionsMapobjectOptionalExample: {"1":8.5,"2":6.3}
post/api/getRiskScoreInfo
POST /api/getRiskScoreInfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "riskScoreOfCollectionsMap": {
    "1": 8.5,
    "2": 6.3
  }
}

POST request for endpoint /api/getCoverageInfoForCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

testedEndpointsMapsobjectOptionalExample: {"1":15,"2":8}
post/api/getCoverageInfoForCollections
POST /api/getCoverageInfoForCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "testedEndpointsMaps": {
    "1": 15,
    "2": 8
  }
}

POST request for endpoint /api/getAllCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

apiCollectionIdinteger · int32OptionalExample: 0
post/api/getAllCollections
POST /api/getAllCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "apiCollections": [
    {
      "hostName": "null",
      "urlsCount": 0,
      "vxlanId": 0,
      "displayName": "AktoSwagger",
      "name": "AktoSwagger",
      "startTs": 1679462413,
      "id": 0
    }
  ],
  "apiCollectionId": 0
}

POST request for endpoint /api/getAllUsersCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

usersCollectionListobjectOptionalExample: {"101":[1,2,3],"102":[1,4]}
post/api/getAllUsersCollections
POST /api/getAllUsersCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "usersCollectionList": {
    "101": [
      1,
      2,
      3
    ],
    "102": [
      1,
      4
    ]
  }
}

POST request for endpoint /api/getSeveritiesCountPerCollection

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
Responses
200

description

application/json

Sample description

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

{
  "apiCollectionId": 1
}
200

description

{
  "severityMapForCollection": {}
}

POST request for endpoint /api/fetchCollectionWiseApiEndpoints

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
skipinteger · int32OptionalExample: 0
Responses
200

description

application/json

Sample description

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

{
  "apiCollectionId": 1,
  "skip": 0
}
200

description

{
  "listOfEndpointsInCollection": [
    {
      "apiCollectionId": 1,
      "url": "/api/users",
      "method": "GET"
    }
  ]
}

POST request for endpoint /api/fetchIpLevelApiCallStats

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
urlstringOptionalExample: /api/users
methodstringOptionalExample: GET
startWindowstringOptionalExample: null
endWindowstringOptionalExample: null
Responses
200

description

application/json

Sample description

post/api/fetchIpLevelApiCallStats
POST /api/fetchIpLevelApiCallStats HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "apiCollectionId": 1,
  "url": "/api/users",
  "method": "GET",
  "startWindow": "null",
  "endWindow": "null"
}
200

description

{
  "bucketStats": [
    {
      "bucketLabel": "0-10",
      "min": 0,
      "max": 10,
      "p50": 5
    }
  ]
}

POST request for endpoint /api/fetchApiInfosForCollection

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
Responses
200

description

application/json

Sample description

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

{
  "apiCollectionId": 1
}
200

description

{
  "response": {
    "apiInfoList": [
      {
        "url": "/api/users",
        "method": "GET",
        "isSensitive": false,
        "authTypes": [
          "text"
        ],
        "riskScore": 7.5
      }
    ],
    "redacted": false
  }
}

POST request for endpoint /api/fetchApiCallStats

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
urlstringOptionalExample: /api/users
methodstringOptionalExample: GET
startEpochinteger · int32OptionalExample: 1712000000
endEpochinteger · int32OptionalExample: 1712100000
Responses
200

description

application/json

Sample description

post/api/fetchApiCallStats
POST /api/fetchApiCallStats HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "apiCollectionId": 1,
  "url": "/api/users",
  "method": "GET",
  "startEpoch": 1712000000,
  "endEpoch": 1712100000
}
200

description

{
  "result": {
    "apiCallStats": [
      {
        "ts": 1712000000,
        "count": 120
      }
    ]
  }
}

POST request for endpoint /api/fetchEndpointsCount

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTimestampinteger · int32OptionalExample: 0
endTimestampinteger · int32OptionalExample: 0
Responses
200

description

application/json

Sample description

newCountinteger · int32OptionalExample: 10
oldCountinteger · int32OptionalExample: 50
post/api/fetchEndpointsCount
POST /api/fetchEndpointsCount HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "startTimestamp": 0,
  "endTimestamp": 0
}
200

description

{
  "newCount": 10,
  "oldCount": 50
}

POST request for endpoint /api/fetchSampleData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

methodstringOptionalExample: POST
apiCollectionIdinteger · int32OptionalExample: 1684477780
urlstringOptionalExample: /api/fetchQuickStartPageState
Responses
200

description

application/json

Sample description

sensitiveSampleDatastringOptionalExample: {}
trafficstringOptionalExample: {}
post/api/fetchSampleData
POST /api/fetchSampleData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "method": "POST",
  "apiCollectionId": 1684477780,
  "url": "/api/fetchQuickStartPageState"
}
200

description

{
  "sensitiveSampleData": "{}",
  "sampleDataList": [
    {
      "id": {
        "method": "POST",
        "bucketEndEpoch": 0,
        "bucketStartEpoch": 0,
        "apiCollectionId": 1684477780,
        "url": "/api/fetchQuickStartPageState",
        "responseCode": -1
      },
      "samples": [
        "text"
      ]
    }
  ],
  "traffic": "{}"
}

POST request for endpoint /api/generateOpenApiFile

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
Responses
200

description

application/json

Sample description

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

{
  "apiCollectionId": 1
}
200

description

{
  "openApiFile": "null"
}

POST request for endpoint /api/fetchAllUrlsAndMethods

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

apiCollectionIdinteger · int32OptionalExample: 1
Responses
200

description

application/json

Sample description

allUrlsstring[]Optional
allMethodsstring[]Optional
post/api/fetchAllUrlsAndMethods
POST /api/fetchAllUrlsAndMethods HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "apiCollectionId": 1
}
200

description

{
  "allUrls": [
    "text"
  ],
  "allMethods": [
    "text"
  ]
}

POST request for endpoint /api/fetchNewEndpointsTrendForHostCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTimestampinteger · int32OptionalExample: 1712000000
endTimestampinteger · int32OptionalExample: 1712100000
Responses
200

description

application/json

Sample description

post/api/fetchNewEndpointsTrendForHostCollections
POST /api/fetchNewEndpointsTrendForHostCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}
200

description

{
  "newEndpointsTrend": [
    {
      "ts": 1712000000,
      "count": 5
    }
  ]
}

POST request for endpoint /api/fetchNewEndpointsTrendForNonHostCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTimestampinteger · int32OptionalExample: 1712000000
endTimestampinteger · int32OptionalExample: 1712100000
Responses
200

description

application/json

Sample description

newEndpointsTrendobject[]Optional
post/api/fetchNewEndpointsTrendForNonHostCollections
POST /api/fetchNewEndpointsTrendForNonHostCollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}
200

description

{
  "newEndpointsTrend": [
    {}
  ]
}

POST request for endpoint /api/fetchAPICollection

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

useHostbooleanOptionalExample: false
apiCollectionIdinteger · int32OptionalExample: 1684477780
Responses
200

description

application/json

Sample description

post/api/fetchAPICollection
POST /api/fetchAPICollection HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "useHost": false,
  "apiCollectionId": 1684477780
}
200

description

{
  "data": {
    "endpoints": [
      {
        "startTs": 1684477861,
        "changesCount": 67,
        "_id": {
          "method": "POST",
          "apiCollectionId": 1684477780,
          "url": "/api/fetchTestRunResultDetails",
          "tags": [
            "API"
          ]
        }
      }
    ],
    "apiInfoList": [
      {
        "lastSeen": 1684477862,
        "actualAuthType": [
          "JWT"
        ],
        "allAuthTypesFound": [
          [
            "JWT"
          ]
        ],
        "violations": "{}",
        "id": {
          "method": "POST",
          "apiCollectionId": 1684477780,
          "url": "/api/fetchTestRunResultDetails"
        }
      }
    ]
  }
}

POST request for endpoint /api/fetchChanges

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

requestbooleanOptionalExample: false
sortKeystringOptionalExample: timestamp
sortOrderinteger · int32OptionalExample: -1
limitinteger · int32OptionalExample: 100
skipinteger · int32OptionalExample: 0
sensitivebooleanOptionalExample: false
endTimestampinteger · int32OptionalExample: 1684477941
startTimestampinteger · int32OptionalExample: 1679293941
Responses
200

description

application/json

Sample description

listOfEndpointsInCollectionstringOptionalExample: null
urlsstringOptionalExample: null
endpointsstringOptionalExample: null
sortKeystringOptionalExample: timestamp
methodstringOptionalExample: null
sortOrderinteger · int32OptionalExample: -1
limitinteger · int32OptionalExample: 100
skipinteger · int32OptionalExample: 0
apiCollectionIdinteger · int32OptionalExample: -1
urlstringOptionalExample: null
post/api/fetchChanges
POST /api/fetchChanges HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "request": false,
  "filterOperators": {
    "color": "OR",
    "method": "OR",
    "param": "OR",
    "isHeader": "OR",
    "domain": "OR",
    "subType": "OR",
    "apiCollectionId": "OR",
    "url": "OR",
    "timestamp": "OR"
  },
  "sortKey": "timestamp",
  "sortOrder": -1,
  "limit": 100,
  "skip": 0,
  "sensitive": false,
  "endTimestamp": 1684477941,
  "startTimestamp": 1679293941
}
200

description

{
  "listOfEndpointsInCollection": "null",
  "filterOperators": {
    "color": "OR",
    "method": "OR",
    "param": "OR",
    "isHeader": "OR",
    "domain": "OR",
    "subType": "OR",
    "apiCollectionId": "OR",
    "url": "OR",
    "timestamp": "OR"
  },
  "urls": "null",
  "endpoints": "null",
  "sortKey": "timestamp",
  "method": "null",
  "response": {
    "data": {
      "endpoints": [
        {
          "isUrlParam": false,
          "method": "POST",
          "maxValue": -9223372036854675000,
          "values": {
            "elements": [
              "http://localhost:8080/api/updateProfile"
            ]
          },
          "count": 2,
          "isPrivate": true,
          "apiCollectionId": 1684477780,
          "sensitive": true,
          "url": "/api/fetchEndpointTrafficData",
          "responseCode": 200,
          "duration": 0,
          "minValue": -9223372036854675000,
          "lastSeen": 1684477920,
          "publicCount": 0,
          "param": "date",
          "isHeader": true,
          "subTypeString": "OTHER",
          "domain": "ENUM",
          "subType": {
            "sensitiveAlways": true,
            "swaggerSchemaClass": "class io.swagger.v3.oas.models.media.BooleanSchema",
            "name": "OTHER",
            "superType": "FLOAT"
          },
          "timestamp": 1684477931,
          "uniqueCount": 0
        }
      ],
      "total": 10604
    }
  },
  "sortOrder": -1,
  "limit": 100,
  "skip": 0,
  "apiCollectionId": -1,
  "url": "null"
}

POST request for endpoint /api/fetchCustomAuthTypes

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

customAuthTypestringOptionalExample: null
usersMapstringOptionalExample: {}
post/api/fetchCustomAuthTypes
POST /api/fetchCustomAuthTypes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "customAuthType": "null",
  "usersMap": "{}"
}

POST request for endpoint /api/fetchDataTypeNames

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

totalSampleDataCountinteger · int32OptionalExample: 0
dataTypesstringOptionalExample: null
currentProcessedinteger · int32OptionalExample: 0
customSubTypeMatchesstringOptionalExample: null
customDataTypestringOptionalExample: null
allDataTypesstring[]OptionalExample: IBAN EUROPE
sensitivePositionstringOptionalExample: null
aktoDataTypestringOptionalExample: null
post/api/fetchDataTypeNames
POST /api/fetchDataTypeNames HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "totalSampleDataCount": 0,
  "dataTypes": "null",
  "currentProcessed": 0,
  "customSubTypeMatches": "null",
  "customDataType": "null",
  "allDataTypes": [
    "IBAN EUROPE"
  ],
  "sensitivePosition": "null",
  "aktoDataType": "null"
}

POST request for endpoint /api/fetchDataTypes

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json
objectOptional

AKTO_ERROR while building schema

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

{}
200

description

{}

POST request for endpoint /api/fetchEndpointTrafficData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

methodstringOptionalExample: POST
endEpochinteger · int32OptionalExample: 1684477910
apiCollectionIdinteger · int32OptionalExample: 1684477780
startEpochinteger · int32OptionalExample: 1679293910
urlstringOptionalExample: /api/fetchQuickStartPageState
Responses
200

description

application/json

Sample description

sensitiveSampleDatastringOptionalExample: {}
sampleDataListstringOptionalExample: null
trafficstringOptionalExample: {}
post/api/fetchEndpointTrafficData
POST /api/fetchEndpointTrafficData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "method": "POST",
  "endEpoch": 1684477910,
  "apiCollectionId": 1684477780,
  "startEpoch": 1679293910,
  "url": "/api/fetchQuickStartPageState"
}
200

description

{
  "sensitiveSampleData": "{}",
  "sampleDataList": "null",
  "traffic": "{}"
}

POST request for endpoint /api/fetchNewParametersTrend

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

endTimestampinteger · int32OptionalExample: 1684477941
startTimestampinteger · int32OptionalExample: 1679293941
Responses
200

description

application/json

Sample description

post/api/fetchNewParametersTrend
POST /api/fetchNewParametersTrend HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "endTimestamp": 1684477941,
  "startTimestamp": 1679293941
}
200

description

{
  "data": {
    "endpoints": [
      {
        "count": 3892,
        "_id": 19496
      }
    ]
  }
}

POST request for endpoint /api/fetchSensitiveParamsForEndpoints

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

urlsstring[]OptionalExample: http://localhost:8080/api/updateProfile
Responses
200

description

application/json

Sample description

post/api/fetchSensitiveParamsForEndpoints
POST /api/fetchSensitiveParamsForEndpoints HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "urls": [
    "http://localhost:8080/api/updateProfile"
  ]
}
200

description

{
  "data": {
    "endpoints": [
      {
        "isUrlParam": false,
        "method": "POST",
        "maxValue": -9223372036854675000,
        "count": 11,
        "sensitive": true,
        "apiCollectionId": 1679462413,
        "isPrivate": true,
        "url": "https://forms.hscollectedforms.net:443/collected-forms/submit/form",
        "responseCode": 200,
        "duration": 0,
        "minValue": 9223372036854675000,
        "lastSeen": 1681120336,
        "publicCount": 0,
        "param": "testingRun#userEmail",
        "subTypeString": "JWT",
        "isHeader": true,
        "domain": "ENUM",
        "subType": {
          "sensitiveAlways": true,
          "name": "JWT",
          "swaggerSchemaClass": "class io.swagger.v3.oas.models.media.EmailSchema",
          "sensitivePosition": [
            "RESPONSE_PAYLOAD"
          ],
          "superType": "CUSTOM"
        },
        "uniqueCount": 0,
        "timestamp": 1681120336
      }
    ]
  }
}

POST request for endpoint /api/fetchTagConfigs

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

description

application/json

Sample description

tagConfigstringOptionalExample: null
namestringOptionalExample: null
activebooleanOptionalExample: false
keyConditionFromUsersstringOptionalExample: null
createNewbooleanOptionalExample: false
keyOperatorstringOptionalExample: null
post/api/fetchTagConfigs
POST /api/fetchTagConfigs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

description

{
  "tagConfigs": {
    "tagConfigs": [
      {
        "name": "API",
        "creatorId": 1679380132,
        "active": true,
        "id": {
          "date": "2023-03-22T10:52:11",
          "timestamp": 1679462531
        },
        "keyConditions": {
          "predicates": [
            {
              "type": "REGEX",
              "value": ".*api.*"
            }
          ],
          "operator": "AND"
        },
        "timestamp": 1679462531
      }
    ],
    "usersMap": {
      "NUMBER": "null"
    }
  },
  "tagConfig": "null",
  "name": "null",
  "active": false,
  "keyConditionFromUsers": "null",
  "createNew": false,
  "keyOperator": "null"
}

POST request for endpoint /api/loadRecentEndpoints

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

endTimestampinteger · int32OptionalExample: 1684477941
startTimestampinteger · int32OptionalExample: 1679293941
Responses
200

description

application/json

Sample description

post/api/loadRecentEndpoints
POST /api/loadRecentEndpoints HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "endTimestamp": 1684477941,
  "startTimestamp": 1679293941
}
200

description

{
  "data": {
    "endpoints": [
      {
        "count": 1,
        "countTs": 44,
        "startTs": 1679927524,
        "_id": {
          "method": "POST",
          "apiCollectionId": 1679462413,
          "url": "http://localhost:8080/api/updateProfile",
          "tags": [
            "API"
          ]
        }
      }
    ],
    "apiInfoList": [
      {
        "lastSeen": 1684477751,
        "actualAuthType": [
          "AUTHORIZATION_HEADER"
        ],
        "allAuthTypesFound": [
          [
            "AUTHORIZATION_HEADER"
          ]
        ],
        "violations": "{}",
        "id": {
          "method": "POST",
          "apiCollectionId": 1681120246,
          "url": "/api/fetchTestRunResultDetails"
        }
      }
    ]
  }
}

POST request for endpoint /api/checkAgentRunModule

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
processIdstringRequired

Process ID to check.

Example: proc-12345
Responses
200

Returns whether the agent is running.

application/json
agentRunningOnModulebooleanOptional

Whether the agent is running on any module.

Example: true
post/api/checkAgentRunModule
POST /api/checkAgentRunModule HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "processId": "proc-12345"
}
200

Returns whether the agent is running.

{
  "agentRunningOnModule": true
}

POST request for endpoint /api/fetchMcpAuditInfoByCollection

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerRequired

API collection ID to fetch audit info for.

Example: 1005
Responses
200

Returns MCP audit information for the collection.

application/json
post/api/fetchMcpAuditInfoByCollection
POST /api/fetchMcpAuditInfoByCollection HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "apiCollectionId": 1005
}
200

Returns MCP audit information for the collection.

{
  "mcpAuditInfoList": [
    {
      "id": "audit-001",
      "server": "mcp-server",
      "timestamp": 1712300000,
      "action": "API_CALL"
    }
  ]
}

POST request for endpoint /api/fetchMcpToolsApiCalls

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerRequired

API collection ID containing MCP tools.

Example: 1005
Responses
200

Returns tool API calls grouped by tool.

application/json
post/api/fetchMcpToolsApiCalls
POST /api/fetchMcpToolsApiCalls HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "apiCollectionId": 1005
}
200

Returns tool API calls grouped by tool.

{
  "response": {
    "tool_1": [
      {
        "url": "/api/users",
        "method": "GET"
      }
    ]
  }
}

POST request for endpoint /api/getAgentLogs

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
agentIdstringRequired

Required agent ID to fetch logs for.

Example: agent-abc123
startTimeintegerOptional

Optional start timestamp in seconds (defaults to 24 hours ago).

Example: 1712214000
endTimeintegerOptional

Optional end timestamp in seconds (defaults to current time).

Example: 1712300000
Responses
200

Returns agent logs for the specified time range.

application/json
post/api/getAgentLogs
POST /api/getAgentLogs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "agentId": "agent-abc123",
  "startTime": 1712214000,
  "endTime": 1712300000
}
200

Returns agent logs for the specified time range.

{
  "agentLogs": [
    {
      "timestamp": 1712299500,
      "level": "INFO",
      "message": "Agent processing MCP tool request"
    }
  ]
}

POST request for endpoint /api/getAgentModels

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

No request body required.

Responses
200

Returns all configured AI models.

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

{}
200

Returns all configured AI models.

{
  "models": [
    {
      "name": "gpt-4o",
      "model": "gpt-4o",
      "type": "OPENAI"
    }
  ]
}

POST request for endpoint /api/getAllAgentRunningDetails

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
processIdstringRequired

Agent run process ID.

Example: proc-12345
Responses
200

Returns complete agent run details for reboot.

application/json
post/api/getAllAgentRunningDetails
POST /api/getAllAgentRunningDetails HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "processId": "proc-12345"
}
200

Returns complete agent run details for reboot.

{
  "response": {
    "type": "initForReboot",
    "data": {},
    "allSubProcesses": [
      {}
    ]
  }
}

POST request for endpoint /api/getAllAgentRuns

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
agentstringOptional

Optional agent type to filter by (e.g., DISCOVERY_AGENT uses different DAO).

Example: DISCOVERY_AGENT
Responses
200

Returns all running agent runs.

application/json
discoveryAgentRunsobject[]Optional

For discovery agents only; empty for other agent types.

post/api/getAllAgentRuns
POST /api/getAllAgentRuns HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "agent": "DISCOVERY_AGENT"
}
200

Returns all running agent runs.

{
  "agentRuns": [
    {
      "processId": "proc-12345",
      "agent": "DISCOVERY_AGENT",
      "state": "RUNNING",
      "createdTs": 1712300000
    }
  ],
  "discoveryAgentRuns": [
    {}
  ]
}

POST request for endpoint /api/getAllAgentRunsObject

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
agentstringRequired

Required agent type to filter by.

Example: DISCOVERY_AGENT
Responses
200

Returns all agent runs for the specified type.

application/json
agentRunsobject[]Optional

All agent runs (any state) of specified type.

post/api/getAllAgentRunsObject
POST /api/getAllAgentRunsObject HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "agent": "DISCOVERY_AGENT"
}
200

Returns all agent runs for the specified type.

{
  "agentRuns": [
    {}
  ]
}

POST request for endpoint /api/getMcpServersByAgent

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
agentIdstringOptional

Optional agent ID to filter MCP servers by.

Example: agent-abc123
deviceIdstringOptional

Optional device ID to filter MCP servers by.

Example: device-xyz789
Responses
200

Returns MCP servers for the specified agent/device.

application/json
post/api/getMcpServersByAgent
POST /api/getMcpServersByAgent HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "agentId": "agent-abc123",
  "deviceId": "device-xyz789"
}
200

Returns MCP servers for the specified agent/device.

{
  "mcpServers": [
    {
      "id": "server-001",
      "name": "Production MCP Server",
      "url": "https://mcp.example.com",
      "lastSeen": 1712300000
    }
  ]
}

POST request for endpoint /api/getMcpdata

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
filterTypestringRequired

Type of filter. One of: TOTAL_APIS, NEW_APIS_7_DAYS, THIRD_PARTY_APIS, RECENT_OPEN_ALERTS, CRITICAL_APIS, TOOLS, PROMPTS, RESOURCES, MCP_SERVER, TOP_3_APPLICATIONS_BY_TRAFFIC, POLICY_GUARDRAIL_APIS.

Example: TOTAL_APIS
Responses
200

Returns MCP data matching the filter type.

application/json
mcpDataCountintegerOptional

Count of data matching the filter type.

Example: 127
auditAlertsobject[]Optional

List of McpAuditInfo (only for RECENT_OPEN_ALERTS filter).

post/api/getMcpdata
POST /api/getMcpdata HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "filterType": "TOTAL_APIS"
}
200

Returns MCP data matching the filter type.

{
  "mcpDataCount": 127,
  "auditAlerts": [
    {}
  ],
  "response": {
    "alertDetails": [
      {}
    ],
    "topApplications": [
      {}
    ]
  }
}

POST request for endpoint /api/getMemberAgents

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

No request body required.

Responses
200

Returns all available agent types.

application/json
agentsstring[]Optional

Array of all available Agent enum values.

Example: ["DISCOVERY_AGENT","CODE_ANALYSIS_AGENT","THREAT_MODELING_AGENT"]
post/api/getMemberAgents
POST /api/getMemberAgents HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Returns all available agent types.

{
  "agents": [
    "DISCOVERY_AGENT",
    "CODE_ANALYSIS_AGENT",
    "THREAT_MODELING_AGENT"
  ]
}

POST request for endpoint /api/receiveDataFromAgent

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
processIdstringRequired

Process ID.

Example: proc-12345
subProcessIdstringRequired

Sub-process ID.

Example: sub-001
attemptIdintegerRequired

Attempt ID.

Example: 1
typestringRequired

Data type. One of: logs, stateChange, subProcessHeading, batchedData, logs_discovery, error_request, increment_processed_apis, metadata_discovery, harData, api_dependencies.

Example: logs
agentstringRequired

Agent type.

Example: DISCOVERY_AGENT
logsobject[]Optional

Agent logs (for type 'logs').

statestringOptional

New state (for type 'stateChange').

Example: COMPLETED
dataobjectOptional

Type-specific data.

Example: {"key":"value"}
subProcessHeadingstringOptional

Heading (for type 'subProcessHeading').

Example: Scanning APIs
currentProcessingUrlInDiscoveryFromAgentstringOptional

Current URL being processed.

Example: https://api.example.com/users
Responses
200

Data received and processed successfully.

application/json
post/api/receiveDataFromAgent
POST /api/receiveDataFromAgent HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "processId": "proc-12345",
  "subProcessId": "sub-001",
  "attemptId": 1,
  "type": "logs",
  "agent": "DISCOVERY_AGENT",
  "logs": [
    {}
  ],
  "state": "COMPLETED",
  "data": {
    "key": "value"
  },
  "subProcessHeading": "Scanning APIs",
  "currentProcessingUrlInDiscoveryFromAgent": "https://api.example.com/users"
}
200

Data received and processed successfully.

{
  "response": {
    "success": "200 ok"
  }
}

POST request for endpoint /api/fetchAllResponsesForApiCollectionOrdered

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerRequired

API collection ID.

Example: 1001
skipintegerOptional

Skip count for pagination (clamped to >= 0).

Example: 0
limitintegerOptional

Result limit (clamped to 1-10).

Example: 5
Responses
200

Returns sample response data.

application/json
post/api/fetchAllResponsesForApiCollectionOrdered
POST /api/fetchAllResponsesForApiCollectionOrdered HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "apiCollectionId": 1001,
  "skip": 0,
  "limit": 5
}
200

Returns sample response data.

{
  "sample": {
    "id": "sample-001",
    "responseCode": 200,
    "responseBody": "{\"data\":[]}"
  }
}

POST request for endpoint /api/getAllSubProcesses

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
processIdstringRequired

Process ID of agent run.

Example: proc-12345
agentstringRequired

Agent type to determine which DAO to use.

Example: DISCOVERY_AGENT
Responses
200

Returns all subprocesses for the agent run.

application/json
subProcessesobject[]Optional

List of AgentSubProcessSingleAttempt objects.

discoverySubProcessesobject[]Optional

For discovery agents only.

post/api/getAllSubProcesses
POST /api/getAllSubProcesses HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "processId": "proc-12345",
  "agent": "DISCOVERY_AGENT"
}
200

Returns all subprocesses for the agent run.

{
  "subProcesses": [
    {}
  ],
  "discoverySubProcesses": [
    {}
  ]
}

POST request for endpoint /api/getFileForDiscovery

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
agentProcessIdstringRequired

Discovery agent run process ID.

Example: proc-12345
fileIdstringRequired

File ID to retrieve.

Example: file-xyz
Responses
200

Returns compressed file content.

application/json
compressedContentstringOptional

Compressed file content (gzip format).

Example: H4sIAERAJGYC/zWPwQqCQBCGXzVcvRskLYmibmFBEUgX6QhFCSlopGYpLYmibvPn7ot06isI33wz00CJxplQaxzidYtQZaLsTppGtf0AAAD//wMAUZN82FAAAAA=
post/api/getFileForDiscovery
POST /api/getFileForDiscovery HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "agentProcessId": "proc-12345",
  "fileId": "file-xyz"
}
200

Returns compressed file content.

{
  "compressedContent": "H4sIAERAJGYC/zWPwQqCQBCGXzVcvRskLYmibmFBEUgX6QhFCSlopGYpLYmibvPn7ot06isI33wz00CJxplQaxzidYtQZaLsTppGtf0AAAD//wMAUZN82FAAAAA="
}

POST request for endpoint /api/getSubProcess

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
processIdstringRequired

Process ID of agent run.

Example: proc-12345
subProcessIdstringRequired

Sub-process ID.

Example: sub-001
attemptIdintegerRequired

Attempt ID.

Example: 1
Responses
200

Returns subprocess details.

application/json
post/api/getSubProcess
POST /api/getSubProcess HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "processId": "proc-12345",
  "subProcessId": "sub-001",
  "attemptId": 1
}
200

Returns subprocess details.

{
  "subprocess": {
    "processId": "proc-12345",
    "subProcessId": "sub-001",
    "attemptId": 1,
    "state": "COMPLETED"
  }
}

GET request for endpoint /api/inventory/{collectionId}/openapi

get
Path parameters
collectionIdstringRequiredExample: 1
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Responses
200

OpenAPI specification retrieved successfully

application/json
openapistringOptionalExample: 3.0.1
pathsobjectOptional
get/api/inventory/{collectionId}/openapi
GET /api/inventory/{collectionId}/openapi HTTP/1.1
Accept: */*
200

OpenAPI specification retrieved successfully

{
  "openapi": "3.0.1",
  "info": {
    "title": "Sample API",
    "version": "1.0.0"
  },
  "paths": {}
}

POST request for endpoint /api/getAPICatalog

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

API catalog retrieved successfully

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

{}
200

API catalog retrieved successfully

{
  "apiCatalogData": [
    {
      "_id": {
        "url": "https://vulnerable-server.akto.io/api/college/eco/students",
        "method": "POST",
        "apiCollectionId": 1111111111
      },
      "apiType": "REST",
      "discoveredTimestamp": 1759319376,
      "lastSeen": 1767352972,
      "responseCodes": [
        200,
        401
      ]
    }
  ]
}

POST request for endpoint /api/fetchCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Collections fetched successfully

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

{}
200

Collections fetched successfully

{
  "collections": [
    {
      "uid": "111111120",
      "name": "Unauthenticated APIs"
    },
    {
      "uid": "111111121",
      "name": "All Apis"
    },
    {
      "uid": "111111128",
      "name": "Login APIs"
    }
  ]
}

POST request for endpoint /api/getCollection

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerOptionalExample: 1111111111
Responses
200

Collection details retrieved successfully

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

{
  "apiCollectionId": 1111111111
}
200

Collection details retrieved successfully

{
  "apiCollections": [
    {
      "_id": 111111120,
      "name": "Unauthenticated APIs",
      "displayName": "Unauthenticated APIs",
      "type": "API_GROUP",
      "deactivated": false,
      "automated": true,
      "startTs": 1767352753
    }
  ]
}

POST request for endpoint /api/fetchIconsForHostnames

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
hostnamesstring[]OptionalExample: ["api.example.com","api2.example.com"]
Responses
200

Icons retrieved successfully

application/json
post/api/fetchIconsForHostnames
POST /api/fetchIconsForHostnames HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "hostnames": [
    "api.example.com",
    "api2.example.com"
  ]
}
200

Icons retrieved successfully

{
  "icons": {
    "api.example.com": "https://example.com/icon.png"
  }
}

POST request for endpoint /api/getApiSequences

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerOptionalExample: 1
Responses
200

API sequences retrieved successfully

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

{
  "apiCollectionId": 1
}
200

API sequences retrieved successfully

{
  "apiSequences": [
    {
      "sequence": [
        "/api/login",
        "/api/user/profile"
      ]
    }
  ]
}

POST request for endpoint /api/getSwaggerDependencies

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Swagger dependencies retrieved successfully

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

{}
200

Swagger dependencies retrieved successfully

{
  "dependencies": [
    {
      "source": "api.example.com",
      "dependencies": [
        "auth-service"
      ]
    }
  ]
}

POST request for endpoint /api/getCountForHostnameDeactivatedCollections

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Count retrieved successfully

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

{}
200

Count retrieved successfully

{
  "deactivatedCollectionsCountByHostname": {
    "vulnerable-server.akto.io": 8,
    "api.internal.example.com": 3,
    "legacy-api.example.com": 5
  },
  "totalDeactivated": 16
}

POST request for endpoint /api/getCountForUningestedApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Count retrieved successfully

application/json
uningestedCountintegerOptionalExample: 234
totalApiCountintegerOptionalExample: 13226
post/api/getCountForUningestedApis
POST /api/getCountForUningestedApis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Count retrieved successfully

{
  "uningestedCount": 234,
  "totalApiCount": 13226
}

POST request for endpoint /api/fetchUningestedApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
skipintegerOptionalExample: 0
limitintegerOptionalExample: 10
Responses
200

Unintegrated APIs retrieved successfully

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

{
  "skip": 0,
  "limit": 10
}
200

Unintegrated APIs retrieved successfully

{
  "apis": [
    {
      "url": "https://vulnerable-server.akto.io/api/college/eco/students",
      "method": "POST",
      "apiCollectionId": 1111111111,
      "discoveredTimestamp": 1759319376
    }
  ],
  "total": 234
}

POST request for endpoint /api/getSensitiveAndUnauthenticatedValue

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerOptionalExample: 1111111111
Responses
200

Sensitive data retrieved successfully

application/json
sensitiveFieldsstring[]OptionalExample: ["content-length","authorization","api-key","x-auth-token"]
isSensitivebooleanOptionalExample: true
unauthenticatedEndpointsCountintegerOptionalExample: 12
sensitiveEndpointsCountintegerOptionalExample: 3
post/api/getSensitiveAndUnauthenticatedValue
POST /api/getSensitiveAndUnauthenticatedValue HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "apiCollectionId": 1111111111
}
200

Sensitive data retrieved successfully

{
  "sensitiveFields": [
    "content-length",
    "authorization",
    "api-key",
    "x-auth-token"
  ],
  "isSensitive": true,
  "unauthenticatedEndpointsCount": 12,
  "sensitiveEndpointsCount": 3
}

POST request for endpoint /api/getHighRiskThirdPartyValue

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerOptionalExample: 1
Responses
200

High-risk third-party APIs retrieved successfully

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

{
  "apiCollectionId": 1
}
200

High-risk third-party APIs retrieved successfully

{
  "highRiskApis": [
    {
      "endpoint": "/api/external/payment",
      "riskScore": 8.5
    }
  ]
}

POST request for endpoint /api/getShadowApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerOptionalExample: 1111111111
Responses
200

Shadow APIs retrieved successfully

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

{
  "apiCollectionId": 1111111111
}
200

Shadow APIs retrieved successfully

{
  "shadowApis": [
    {
      "url": "https://vulnerable-server.akto.io/api/college/student-grades",
      "method": "GET",
      "discoveredTimestamp": 1759319376,
      "lastSeen": 1767352972,
      "riskScore": 7.2
    }
  ],
  "totalShadowApisCount": 23
}

POST request for endpoint /api/fetchActionItemsApiInfo

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Action items retrieved successfully

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

{}
200

Action items retrieved successfully

{
  "actionItems": [
    {
      "id": "item_123",
      "title": "Review shadow API",
      "priority": "HIGH"
    }
  ]
}

POST request for endpoint /api/fetchAllUnauthenticatedApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Unauthenticated APIs retrieved successfully

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

{}
200

Unauthenticated APIs retrieved successfully

{
  "apis": [
    {
      "url": "https://vuln-server.akto.io/api/v2/feePayment",
      "method": "GET",
      "apiCollectionId": 1111111111,
      "riskScore": 0
    }
  ],
  "totalCount": 145
}

POST request for endpoint /api/getCustomerEndpoints

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Customer endpoints retrieved successfully

application/json
totalEndpointsintegerOptionalExample: 13226
activeEndpointsintegerOptionalExample: 12452
inactiveEndpointsintegerOptionalExample: 774
sensitiveEndpointsintegerOptionalExample: 234
unauthenticatedEndpointsintegerOptionalExample: 145
post/api/getCustomerEndpoints
POST /api/getCustomerEndpoints HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Customer endpoints retrieved successfully

{
  "totalEndpoints": 13226,
  "activeEndpoints": 12452,
  "inactiveEndpoints": 774,
  "sensitiveEndpoints": 234,
  "unauthenticatedEndpoints": 145
}

POST request for endpoint /api/getDeMergedApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerOptionalExample: 1
Responses
200

De-merged APIs retrieved successfully

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

{
  "apiCollectionId": 1
}
200

De-merged APIs retrieved successfully

{
  "deMergedApis": [
    {
      "original": "GET /api/users",
      "separated": [
        "GET /api/users/list",
        "GET /api/users/{id}"
      ]
    }
  ]
}

POST request for endpoint /api/fetchNonStandardHeaderKeys

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Non-standard headers retrieved successfully

application/json
nonStandardHeadersstring[]OptionalExample: ["X-Custom-Header","X-API-Version","X-Request-ID"]
post/api/fetchNonStandardHeaderKeys
POST /api/fetchNonStandardHeaderKeys HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Non-standard headers retrieved successfully

{
  "nonStandardHeaders": [
    "X-Custom-Header",
    "X-API-Version",
    "X-Request-ID"
  ]
}

POST request for endpoint /api/getUniqueHostsTested

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Unique hosts retrieved successfully

application/json
uniqueHostsstring[]OptionalExample: ["api.example.com","api2.example.com","internal-api.example.com"]
countintegerOptionalExample: 3
post/api/getUniqueHostsTested
POST /api/getUniqueHostsTested HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Unique hosts retrieved successfully

{
  "uniqueHosts": [
    "api.example.com",
    "api2.example.com",
    "internal-api.example.com"
  ],
  "count": 3
}

POST request for endpoint /api/fetchCountMapOfApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

API count map retrieved successfully

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

{}
200

API count map retrieved successfully

{
  "countMap": {
    "INTEGER_32": 89234,
    "STRING": 156234,
    "BOOLEAN": 42125,
    "OBJECT": 28934,
    "ARRAY": 12483
  },
  "totalCount": 444217
}

Data Types & Sample Data

#
API
Description

1

POST /api/fetchAllSampleData

Fetches all sample Agentic Request/Agentic Response data entries across agentic collections.

POST request for endpoint /api/fetchAllSampleData

post
Body
apiCollectionIdintegerRequired

ID of the API collection to fetch sample data for

Example: 1748293710
skipintegerOptional

Number of records to skip for pagination

Example: 0
limitintegerOptional

Maximum number of records to return (defaults to 50 if 0 or unset)

Example: 20
Responses
200

Sample data list retrieved successfully

application/json
post/api/fetchAllSampleData
POST /api/fetchAllSampleData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "apiCollectionId": 1748293710,
  "skip": 0,
  "limit": 20
}
{
  "sampleDataList": [
    {
      "_id": {
        "apiCollectionId": 1748293710,
        "url": "https://api.example.com/api/users/profile",
        "method": "GET",
        "responseCode": -1,
        "bucketStartEpoch": 0,
        "bucketEndEpoch": 0
      },
      "collectionIds": [
        1748293710,
        1748293721,
        1748293748
      ],
      "samples": [
        "[RAW_HTTP_SAMPLE_STRING]"
      ]
    }
  ]
}

Endpoints & Data Management

#
API
Description

1

POST /api/fetchApiInfosFromSTIs

Fetch API metadata for all endpoints in a collection from single_type_info, returning both the raw STI list and enriched response object.

2

POST /api/fetchApiInfoList

Fetch all ApiInfo records for a collection with auth types calculated.

3

POST /api/getSingleEndpoint

Fetch the ApiInfo record for a single endpoint identified by URL, method, and collection ID.

4

POST /api/findMissingUrls

Check whether a list of URLs exist in the api_info and single_type_info collections, returning per-URL presence status.

5

POST /api/fetchRecentParams

Fetch recently discovered parameters (new fields added to endpoints) within a time window.

6

POST /api/getEndpointsListFromConditions

Return a paginated list of up to 200 endpoints matching a set of collection conditions, with accurate total count.

7

POST /api/getEndpointsFromConditions

Return only the total count of endpoints matching given conditions — lighter than getEndpointsListFromConditions.

8

POST /api/fetchEndpointsBasedOnHostName

Fetch all endpoint URL/method pairs for a collection identified by its hostname, with pagination support.

9

POST /api/fetchEndpointDiscoveryData

Consolidated endpoint discovery statistics (shadow, sensitive, no-auth, normal counts) for a given time window.

10

POST /api/listAllSensitiveFields

Retrieve all parameters currently flagged as sensitive in the sensitive_param_infos collection.

11

POST /api/getAPIInfosForMissingData

Audit the api_info collection for gaps and return aggregate counts per gap category.

POST request for endpoint /api/fetchApiInfosFromSTIs

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerRequiredExample: 1111111
Responses
200

API info fetched successfully

application/json
post/api/fetchApiInfosFromSTIs
POST /api/fetchApiInfosFromSTIs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "apiCollectionId": 1111111
}
200

API info fetched successfully

{
  "list": [
    {
      "_id": {
        "url": "https://api.example.com/api/users/profile",
        "method": "GET",
        "apiCollectionId": 1111111
      },
      "apiType": "REST",
      "discoveredTimestamp": 1672531200,
      "lastSeen": 1675209600,
      "responseCodes": [
        200,
        401
      ]
    }
  ],
  "response": {
    "apiInfoList": [
      {
        "id": {
          "url": "https://api.example.com/api/users/profile",
          "method": "GET",
          "apiCollectionId": 1111111
        },
        "allAuthTypesFound": [
          [
            "AUTHORIZATION_HEADER_BEARER"
          ]
        ],
        "actualAuthType": [
          "AUTHORIZATION_HEADER_BEARER"
        ],
        "isPublic": false
      }
    ]
  }
}

POST request for endpoint /api/fetchApiInfoList

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
apiCollectionIdintegerRequiredExample: 1111111
Responses
200

ApiInfo list retrieved successfully

application/json
post/api/fetchApiInfoList
POST /api/fetchApiInfoList HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "apiCollectionId": 1111111
}
200

ApiInfo list retrieved successfully

{
  "apiInfoList": [
    {
      "id": {
        "url": "https://api.example.com/api/orders/INTEGER",
        "method": "GET",
        "apiCollectionId": 1111111
      },
      "allAuthTypesFound": [
        [
          "AUTHORIZATION_HEADER_BEARER"
        ]
      ],
      "actualAuthType": [
        "AUTHORIZATION_HEADER_BEARER"
      ],
      "apiAccessType": "ONLY_AUTHENTICATED",
      "lastSeen": 1675209600,
      "discoveredTimestamp": 1672531200,
      "responseCodes": [
        200,
        404
      ],
      "isPublic": false
    }
  ]
}

POST request for endpoint /api/getSingleEndpoint

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
urlstringRequiredExample: https://api.example.com/api/orders/INTEGER
methodstringRequiredExample: GET
apiCollectionIdintegerRequiredExample: 1111111
Responses
200

Endpoint info retrieved successfully. apiInfo is null if the endpoint does not exist.

application/json
post/api/getSingleEndpoint
POST /api/getSingleEndpoint HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "url": "https://api.example.com/api/orders/INTEGER",
  "method": "GET",
  "apiCollectionId": 1111111
}
200

Endpoint info retrieved successfully. apiInfo is null if the endpoint does not exist.

{
  "apiInfo": {
    "id": {
      "url": "https://api.example.com/api/orders/INTEGER",
      "method": "GET",
      "apiCollectionId": 1111111
    },
    "allAuthTypesFound": [
      [
        "AUTHORIZATION_HEADER_BEARER"
      ]
    ],
    "actualAuthType": [
      "AUTHORIZATION_HEADER_BEARER"
    ],
    "apiAccessType": "ONLY_AUTHENTICATED",
    "lastSeen": 1675209600,
    "discoveredTimestamp": 1672531200,
    "responseCodes": [
      200,
      401,
      404
    ]
  }
}

POST request for endpoint /api/findMissingUrls

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
missingUrlsstring[]Required

List of URL paths to check. Pass an empty array to get an empty result.

Example: ["/api/payments/refund","/api/users/admin/delete","/api/reports/export"]
Responses
200

URL presence results returned (sorted alphabetically by URL)

application/json
post/api/findMissingUrls
POST /api/findMissingUrls HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "missingUrls": [
    "/api/payments/refund",
    "/api/users/admin/delete",
    "/api/reports/export"
  ]
}
200

URL presence results returned (sorted alphabetically by URL)

{
  "missingUrlsResults": [
    {
      "url": "/api/payments/refund",
      "collectionId": 1111111,
      "name": "payments-service",
      "hasApiInfo": true,
      "hasSingleTypeInfo": false
    },
    {
      "url": "/api/reports/export",
      "collectionId": null,
      "name": "",
      "hasApiInfo": false,
      "hasSingleTypeInfo": false
    }
  ]
}

POST request for endpoint /api/fetchRecentParams

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
startTimestampintegerRequired

Start of time window (Unix epoch seconds)

Example: 1672531200
endTimestampintegerRequired

End of time window (Unix epoch seconds)

Example: 1675209600
Responses
200

Recent params fetched (up to 20,000 STI records)

application/json
post/api/fetchRecentParams
POST /api/fetchRecentParams HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1672531200,
  "endTimestamp": 1675209600
}
200

Recent params fetched (up to 20,000 STI records)

{
  "data": {
    "endpoints": [
      {
        "apiCollectionId": 1111111,
        "url": "https://api.example.com/api/users/profile",
        "method": "POST",
        "param": "newField",
        "isHeader": false,
        "responseCode": -1,
        "timestamp": 1673000000,
        "subType": "STRING"
      }
    ]
  }
}

POST request for endpoint /api/getEndpointsListFromConditions

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
Responses
200

Endpoint list and total count returned

application/json
apiCountintegerOptional

Total number of matching endpoints (not limited to page size)

Example: 48
responseobjectOptional

Enriched endpoint data (auth types, risk, sensitivity)

post/api/getEndpointsListFromConditions
POST /api/getEndpointsListFromConditions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "conditions": [
    {
      "type": "CUSTOM",
      "operator": "OR",
      "data": {
        "apiList": [
          {
            "apiCollectionId": 1111111,
            "url": "https://api.example.com/api/users/profile",
            "method": "GET"
          },
          {
            "apiCollectionId": 1111111,
            "url": "https://api.example.com/api/orders/INTEGER",
            "method": "POST"
          }
        ]
      }
    }
  ]
}
200

Endpoint list and total count returned

{
  "apiCount": 48,
  "response": {}
}

POST request for endpoint /api/getEndpointsFromConditions

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
Responses
200

Count of matching endpoints returned

application/json
apiCountintegerOptionalExample: 312
post/api/getEndpointsFromConditions
POST /api/getEndpointsFromConditions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "conditions": [
    {
      "type": "COLLECTION",
      "operator": "OR",
      "data": {}
    }
  ]
}
200

Count of matching endpoints returned

{
  "apiCount": 312
}

POST request for endpoint /api/fetchEndpointsBasedOnHostName

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
hostNamestringRequiredExample: api.example.com
skipintegerOptional

Number of records to skip for pagination

Example: 0
Responses
200

Endpoints for the given host returned

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

{
  "hostName": "api.example.com",
  "skip": 0
}
{
  "endpoints": [
    {
      "url": "https://api.example.com/api/users/profile",
      "method": "GET"
    },
    {
      "url": "https://api.example.com/api/orders/INTEGER",
      "method": "POST"
    },
    {
      "url": "https://api.example.com/api/payments/refund",
      "method": "POST"
    }
  ]
}

POST request for endpoint /api/fetchEndpointDiscoveryData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
startTimestampintegerOptional

Start of time window (Unix epoch seconds)

Example: 1672531200
endTimestampintegerOptional

End of time window (Unix epoch seconds). Defaults to now if 0.

Example: 1675209600
Responses
200

Discovery stats returned

application/json
discoveryStatsobjectOptional

Shape depends on context source (API Security vs Agentic)

Example: {"shadowApis":14,"sensitiveApis":8,"noAuthApis":3,"newEndpoints":27,"totalEndpoints":834}
post/api/fetchEndpointDiscoveryData
POST /api/fetchEndpointDiscoveryData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1672531200,
  "endTimestamp": 1675209600
}
200

Discovery stats returned

{
  "discoveryStats": {
    "shadowApis": 14,
    "sensitiveApis": 8,
    "noAuthApis": 3,
    "newEndpoints": 27,
    "totalEndpoints": 834
  }
}

POST request for endpoint /api/listAllSensitiveFields

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Sensitive fields list returned

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

{}
200

Sensitive fields list returned

{
  "ret": {
    "data": [
      {
        "url": "https://api.example.com/api/users/profile",
        "method": "GET",
        "responseCode": 200,
        "isHeader": false,
        "param": "ssn",
        "apiCollectionId": 1111111,
        "sensitive": true
      }
    ]
  }
}

POST request for endpoint /api/getAPIInfosForMissingData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
startTimeStampintegerOptional

Start of audit window (Unix epoch seconds)

Example: 1672531200
endTimeStampintegerOptional

End of audit window (Unix epoch seconds)

Example: 1675209600
Responses
200

API info gap counts returned

application/json
totalMissingintegerOptional

Endpoints in STI but absent from api_info

Example: 14
apiTypeMissingintegerOptional

Endpoints with no sample data to determine API type

Example: 6
authNotCalculatedintegerOptional

Endpoints where auth type has not been computed

Example: 3
accessTypeNotCalculatedintegerOptional

Endpoints where access type has not been computed

Example: 2
redundantApiInfoKeysintegerOptional

api_info entries with no matching STI record

Example: 1
post/api/getAPIInfosForMissingData
POST /api/getAPIInfosForMissingData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimeStamp": 1672531200,
  "endTimeStamp": 1675209600
}
200

API info gap counts returned

{
  "totalMissing": 14,
  "apiTypeMissing": 6,
  "authNotCalculated": 3,
  "accessTypeNotCalculated": 2,
  "redundantApiInfoKeys": 1
}
PreviousAgentic DiscoveryNextModify Data

Last updated