Code Analysis

API	Description
POST /api/fetchCodeAnalysisApiInfos	Fetch code-analysis API info for a given traffic collection, returning matched endpoints discovered from source code.
POST /api/fetchCodeAnalysisRepos	Fetch all registered source-code repositories, optionally filtered by source-code type.
POST /api/getSourceCodeCollectionsForDirectories	Return all code analysis collections that have at least one endpoint under a given backend directory path prefix.
POST /api/getApisForChosenCollectionForSourceCode	Fetch request/response schema information for all API endpoints in the specified code analysis collections.
POST /api/addCodeAnalysisRepo	Add one or more source-code repositories for code-analysis scanning (upsert — re-adding an existing repo is a no-op).
POST /api/runCodeAnalysisRepo	Trigger an immediate scan for one or more registered repositories by setting their schedule time to now.
POST /api/deleteCodeAnalysisRepo	Delete a source-code repository registration, removing all documents matching the given project and repo name.

POST request for endpoint /api/fetchCodeAnalysisApiInfos

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

apiCollectionIdintegerOptionalExample: 1111111

Responses

200

Code analysis API info retrieved successfully

application/json

post

/api/fetchCodeAnalysisApiInfos

HTTPcURLJavaScriptPython

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

{
  "apiCollectionId": 1111111
}

200

Code analysis API info retrieved successfully

{
  "codeAnalysisCollectionInfo": {
    "codeAnalysisCollection": {
      "_id": "64a1f2e3b5c7d8e9f0a1b2c3",
      "name": "payments-service",
      "projectDir": "src/main/java/com/example/payments",
      "apiCollectionId": 1111111
    },
    "codeAnalysisApisMap": {
      "GET /api/payments/transactions": {
        "_id": {
          "codeAnalysisCollectionId": "64a1f2e3b5c7d8e9f0a1b2c3",
          "method": "GET",
          "endpoint": "/api/payments/transactions"
        },
        "location": {
          "filePath": "src/main/java/com/example/payments/TransactionController.java",
          "fileName": "TransactionController.java",
          "fileLink": "https://github.com/example-org/payments-service/blob/main/src/main/java/com/example/payments/TransactionController.java#L58",
          "lineNo": 58
        },
        "discoveredTs": 1672531200,
        "lastSeenTs": 1675209600
      },
      "POST /api/payments/refund": {
        "_id": {
          "codeAnalysisCollectionId": "64a1f2e3b5c7d8e9f0a1b2c3",
          "method": "POST",
          "endpoint": "/api/payments/refund"
        },
        "location": {
          "filePath": "src/main/java/com/example/payments/RefundController.java",
          "fileName": "RefundController.java",
          "fileLink": "https://github.com/example-org/payments-service/blob/main/src/main/java/com/example/payments/RefundController.java#L34",
          "lineNo": 34
        },
        "discoveredTs": 1672531200,
        "lastSeenTs": 1675209600
      }
    }
  }
}

POST request for endpoint /api/fetchCodeAnalysisRepos

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

sourceCodeTypestring · enumOptional

Filter by SCM provider. Omit or set to BITBUCKET to also match legacy repos without a type field.

Example: GITHUBPossible values:

Responses

200

Repositories fetched successfully

application/json

post

/api/fetchCodeAnalysisRepos

HTTPcURLJavaScriptPython

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

{
  "sourceCodeType": "GITHUB"
}

200

Repositories fetched successfully

{
  "codeAnalysisRepos": [
    {
      "hexId": "64a1f2e3b5c7d8e9f0a1b2c4",
      "projectName": "example-org",
      "repoName": "payments-service",
      "sourceCodeType": "GITHUB",
      "lastRun": 1675123200,
      "scheduleTime": 1675209600
    },
    {
      "hexId": "64a1f2e3b5c7d8e9f0a1b2c5",
      "projectName": "example-org",
      "repoName": "user-service",
      "sourceCodeType": "GITHUB",
      "lastRun": 1675036800,
      "scheduleTime": 1675209600
    }
  ]
}

POST request for endpoint /api/getSourceCodeCollectionsForDirectories

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

chosenBackendDirectorystringRequired

Directory path prefix used as a regex anchor (^prefix.*) to filter CodeAnalysisApiInfo by location.filePath

Example: src/main/java/com/example/payments

Responses

200

Matching collections retrieved successfully

application/json

post

/api/getSourceCodeCollectionsForDirectories

HTTPcURLJavaScriptPython

POST /api/getSourceCodeCollectionsForDirectories HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "chosenBackendDirectory": "src/main/java/com/example/payments"
}

200

Matching collections retrieved successfully

{
  "codeAnalysisCollectionIdList": [
    {
      "id": "64a1f2e3b5c7d8e9f0a1b2c3",
      "name": "payments-service",
      "count": 24,
      "apiCollectionId": 1111111
    },
    {
      "id": "64a1f2e3b5c7d8e9f0a1b2d7",
      "name": "billing-service",
      "count": 11,
      "apiCollectionId": 2222222
    }
  ]
}

POST request for endpoint /api/getApisForChosenCollectionForSourceCode

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

chosenCodeAnalysisCollectionIdsstring[]Required

Hex ObjectId strings of CodeAnalysisCollections to load. Pass an empty array to return an empty result.

Example: ["64a1f2e3b5c7d8e9f0a1b2c3","64a1f2e3b5c7d8e9f0a1b2d7"]

Responses

200

API endpoints with schemas retrieved successfully

application/json

post

/api/getApisForChosenCollectionForSourceCode

HTTPcURLJavaScriptPython

POST /api/getApisForChosenCollectionForSourceCode HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "chosenCodeAnalysisCollectionIds": [
    "64a1f2e3b5c7d8e9f0a1b2c3",
    "64a1f2e3b5c7d8e9f0a1b2d7"
  ]
}

200

API endpoints with schemas retrieved successfully

{
  "apiInfoKeysWithSchema": [
    {
      "apiCollectionId": 1111111,
      "url": "/api/payments/transactions/INTEGER",
      "method": "GET",
      "requestSchema": {},
      "responseSchema": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "createdAt": {
            "type": "integer"
          }
        }
      }
    },
    {
      "apiCollectionId": 1111111,
      "url": "/api/payments/refund",
      "method": "POST",
      "requestSchema": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        }
      },
      "responseSchema": {
        "type": "object",
        "properties": {
          "refundId": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        }
      }
    }
  ]
}

POST request for endpoint /api/addCodeAnalysisRepo

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

Responses

200

Repositories added (or already existed) successfully

application/json

objectOptional

400

Validation error — codeAnalysisRepos list was null or empty

application/json

post

/api/addCodeAnalysisRepo

HTTPcURLJavaScriptPython

POST /api/addCodeAnalysisRepo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "codeAnalysisRepos": [
    {
      "projectName": "example-org",
      "repoName": "payments-service",
      "sourceCodeType": "GITHUB"
    },
    {
      "projectName": "example-org",
      "repoName": "user-service",
      "sourceCodeType": "GITHUB"
    }
  ]
}

{}

POST request for endpoint /api/runCodeAnalysisRepo

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

Responses

200

Scan triggered successfully — scheduleTime updated to current timestamp

application/json

objectOptional

400

Validation error — codeAnalysisRepos list was null or empty

application/json

post

/api/runCodeAnalysisRepo

HTTPcURLJavaScriptPython

POST /api/runCodeAnalysisRepo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "codeAnalysisRepos": [
    {
      "repoName": "payments-service",
      "projectName": "example-org"
    }
  ]
}

{}

POST request for endpoint /api/deleteCodeAnalysisRepo

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

Responses

200

Repository deleted successfully

application/json

objectOptional

400

Validation error — codeAnalysisRepo was null

application/json

post

/api/deleteCodeAnalysisRepo

HTTPcURLJavaScriptPython

POST /api/deleteCodeAnalysisRepo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "codeAnalysisRepo": {
    "repoName": "payments-service",
    "projectName": "example-org"
  }
}

{}