> For the complete documentation index, see [llms.txt](https://docs.akto.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.akto.io/api-reference/discovery/modify-data.md). # Modify Data
APIDescription
POST /api/createCollectionCreate a new API collection in Akto.
POST /api/createCustomCollectionCreate a custom API collection by grouping selected APIs.
POST /api/addApisToCustomCollectionAdd APIs to an existing custom collection.
POST /api/saveCollectionDescriptionSave or update the description of a collection.
POST /api/updateEnvTypeUpdate the environment type (e.g., prod, staging) for a collection.
POST /api/toggleCollectionsOutOfTestScopeMark/unmark collections as out of test scope.
POST /api/deactivateCollectionsDeactivate specific collections so they are no longer active.
POST /api/deleteMultipleCollectionsDelete multiple collections at once.
POST /api/redactCollectionRedact sensitive data within a collection.
POST /api/saveEndpointDescriptionSave or update the description of a specific API endpoint.
POST /api/loadParamsOfEndpointLoad the parameters (query, path, body) of a given API endpoint.
POST /api/loadSensitiveParametersLoad parameters identified as sensitive for a given endpoint/collection.
POST /api/importDataFromOpenApiSpecImport APIs and collections from an OpenAPI specification file.
POST /api/uploadHarUpload a HAR (HTTP Archive) file to create or update API data in Akto.
POST /api/importSwaggerLogsApprove and ingest a Swagger/OpenAPI file upload by pushing approved records to the API inventory via Kafka.
POST /api/importImpervaSchemaParse an Imperva JSON schema and push the traffic asynchronously to the API inventory via Kafka.
POST /api/importFromUrlCreate an API collection by firing an HTTP request to the given URL and ingesting the response asynchronously.
POST /api/addOrUpdatePostmanCredSave or update the Postman API key and workspace ID for the current account.
POST /api/createPostmanApiBuild an OpenAPI spec from a collection and export it to the Postman API asynchronously.
POST /api/savePostmanCollectionFetch a specified Postman collection via the stored API key, convert it, and store it in Akto.
POST /api/ingestPostmanApprove and ingest a Postman file upload by pushing approved records to the API inventory via Kafka.
POST /api/deletePostmanImportLogsMark a Postman upload record for deletion so it is excluded from future import log listings.
## POST /api/addApisToCustomCollection > /api/addApisToCustomCollection ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/addApisToCustomCollection":{"post":{"summary":"/api/addApisToCustomCollection","operationId":"https://app.akto.io/api/addApisToCustomCollection-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"collectionName":{"type":"string","types":["string"]},"apiList":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"],"required":["method","apiCollectionId","url"]},"types":["array"]}},"types":["object"],"required":["collectionName","apiList"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"apiList":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"severityInfo":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"apiCollections":{"type":"array","items":{"type":"object","properties":{"hostName":{"type":"string","types":["string"]},"urlsCount":{"type":"integer","format":"int32","types":["integer"]},"runDependencyAnalyser":{"type":"boolean","types":["boolean"]},"displayName":{"type":"string","types":["string"]},"redact":{"type":"boolean","types":["boolean"]},"sseCallbackUrl":{"type":"string","types":["string"]},"description":{"type":"string","types":["string"]},"startTs":{"type":"integer","format":"int32","types":["integer"]},"mcpCollection":{"type":"boolean","types":["boolean"]},"type":{"type":"string","types":["string"]},"deactivated":{"type":"boolean","types":["boolean"]},"automated":{"type":"boolean","types":["boolean"]},"matchDependencyWithOtherCollections":{"type":"boolean","types":["boolean"]},"envType":{"type":"string","types":["string"]},"vxlanId":{"type":"integer","format":"int32","types":["integer"]},"tagsList":{"type":"string","types":["string"]},"name":{"type":"string","types":["string"]},"userSetEnvType":{"type":"string","types":["string"]},"genAICollection":{"type":"boolean","types":["boolean"]},"id":{"type":"integer","format":"int32","types":["integer"]},"isOutOfTestingScope":{"type":"boolean","types":["boolean"]},"sampleCollectionsDropped":{"type":"boolean","types":["boolean"]},"conditions":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"uningestedApiList":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/saveEndpointDescription > /api/saveEndpointDescription ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/saveEndpointDescription":{"post":{"summary":"/api/saveEndpointDescription","operationId":"https://app.akto.io/api/saveEndpointDescription-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"description":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"],"required":["method","description","apiCollectionId","url"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"listOfEndpointsInCollection":{"type":"string","types":["string"]},"notTestedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpoints":{"type":"string","types":["string"]},"method":{"type":"string","types":["string"]},"oldCount":{"type":"integer","format":"int32","types":["integer"]},"newCount":{"type":"integer","format":"int32","types":["integer"]},"description":{"type":"string","types":["string"]},"skip":{"type":"integer","format":"int32","types":["integer"]},"severitiesCountPerCollection":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"filters":{"type":"string","types":["string"]},"summaryInfoForChanges":{"type":"string","types":["string"]},"accessTypes":{"type":"string","types":["string"]},"url":{"type":"string","types":["string"]},"deMergedApis":{"type":"string","types":["string"]},"urls":{"type":"string","types":["string"]},"filterOperators":{"type":"string","types":["string"]},"sortKey":{"type":"string","types":["string"]},"severityMapForCollection":{"type":"string","types":["string"]},"response":{"type":"string","types":["string"]},"sortOrder":{"type":"integer","format":"int32","types":["integer"]},"limit":{"type":"integer","format":"int32","types":["integer"]},"onlyOnceTestedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/updateEnvType > /api/updateEnvType ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/updateEnvType":{"post":{"summary":"/api/updateEnvType","operationId":"https://app.akto.io/api/updateEnvType-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"resetEnvTypes":{"type":"boolean","types":["boolean"]},"envType":{"type":"array","items":{"type":"object","properties":{"keyName":{"type":"string","types":["string"]},"lastUpdatedTs":{"type":"integer","format":"int32","types":["integer"]},"value":{"type":"string","types":["string"]}},"types":["object"],"required":["keyName","lastUpdatedTs","value"]},"types":["array"]},"apiCollectionIds":{"type":"array","items":{"type":"integer","format":"int32","types":["integer"]},"types":["array"]}},"types":["object"],"required":["resetEnvTypes","envType","apiCollectionIds"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"uningestedApiList":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/toggleCollectionsOutOfTestScope > /api/toggleCollectionsOutOfTestScope ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/toggleCollectionsOutOfTestScope":{"post":{"summary":"/api/toggleCollectionsOutOfTestScope","operationId":"https://app.akto.io/api/toggleCollectionsOutOfTestScope-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"currentIsOutOfTestingScopeVal":{"type":"boolean","types":["boolean"]},"apiCollectionIds":{"type":"array","items":{"type":"integer","format":"int32","types":["integer"]},"types":["array"]}},"types":["object"],"required":["currentIsOutOfTestingScopeVal","apiCollectionIds"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","types":["boolean"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/uploadHar > /api/uploadHar ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/uploadHar":{"post":{"summary":"/api/uploadHar","operationId":"https://app.akto.io/api/uploadHar-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skipKafka":{"type":"string","types":["string"]},"harString":{"type":"string","types":["string"]},"hsFile":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["skipKafka","harString","hsFile","apiCollectionId"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"skipKafka":{"type":"boolean","types":["boolean"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/deleteMultipleCollections > /api/deleteMultipleCollections ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/deleteMultipleCollections":{"post":{"summary":"/api/deleteMultipleCollections","operationId":"https://app.akto.io/api/deleteMultipleCollections-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiCollections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["id"]},"types":["array"]}},"types":["object"],"required":["apiCollections"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"apiCollections":{"type":"array","items":{"type":"object","properties":{"hostName":{"type":"string","types":["string"]},"urlsCount":{"type":"integer","format":"int32","types":["integer"]},"runDependencyAnalyser":{"type":"boolean","types":["boolean"]},"displayName":{"type":"string","types":["string"]},"redact":{"type":"boolean","types":["boolean"]},"sseCallbackUrl":{"type":"string","types":["string"]},"description":{"type":"string","types":["string"]},"startTs":{"type":"integer","format":"int32","types":["integer"]},"mcpCollection":{"type":"boolean","types":["boolean"]},"type":{"type":"string","types":["string"]},"deactivated":{"type":"boolean","types":["boolean"]},"urls":{"type":"string","types":["string"]},"automated":{"type":"boolean","types":["boolean"]},"matchDependencyWithOtherCollections":{"type":"boolean","types":["boolean"]},"envType":{"type":"string","types":["string"]},"vxlanId":{"type":"integer","format":"int32","types":["integer"]},"tagsList":{"type":"string","types":["string"]},"name":{"type":"string","types":["string"]},"genAICollection":{"type":"boolean","types":["boolean"]},"userSetEnvType":{"type":"string","types":["string"]},"id":{"type":"integer","format":"int32","types":["integer"]},"isOutOfTestingScope":{"type":"boolean","types":["boolean"]},"sampleCollectionsDropped":{"type":"boolean","types":["boolean"]},"conditions":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"uningestedApiList":{"type":"string","types":["string"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/saveCollectionDescription > /api/saveCollectionDescription ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/saveCollectionDescription":{"post":{"summary":"/api/saveCollectionDescription","operationId":"https://app.akto.io/api/saveCollectionDescription-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["description","apiCollectionId"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"uningestedApiList":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/loadSensitiveParameters > /api/loadSensitiveParameters ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/loadSensitiveParameters":{"post":{"summary":"/api/loadSensitiveParameters","operationId":"https://app.akto.io/api/loadSensitiveParameters-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["apiCollectionId"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"sources":{"type":"object","properties":{"HAR":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}},"types":["object"]},"isPrivate":{"type":"boolean","types":["boolean"]},"responseCode":{"type":"integer","format":"int32","types":["integer"]},"duration":{"type":"integer","format":"int32","types":["integer"]},"minValue":{"type":"integer","format":"int32","types":["integer"]},"param":{"type":"string","types":["string"]},"subTypeString":{"type":"string","types":["string"]},"id":{"type":"object","properties":{"date":{"type":"string","types":["string"]},"timestamp":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"timestamp":{"type":"integer","format":"int32","types":["integer"]},"isUrlParam":{"type":"boolean","types":["boolean"]},"method":{"type":"string","types":["string"]},"maxValue":{"type":"integer","format":"int32","types":["integer"]},"isQueryParam":{"type":"boolean","types":["boolean"]},"strId":{"type":"string","types":["string"]},"count":{"type":"integer","format":"int32","types":["integer"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"sensitive":{"type":"boolean","types":["boolean"]},"url":{"type":"string","types":["string"]},"lastSeen":{"type":"integer","format":"int32","types":["integer"]},"publicCount":{"type":"integer","format":"int32","types":["integer"]},"isHeader":{"type":"boolean","types":["boolean"]},"collectionIds":{"type":"array","items":{"type":"integer","format":"int32","types":["integer"]},"types":["array"]},"domain":{"type":"string","types":["string"]},"subType":{"type":"object","properties":{"sensitiveAlways":{"type":"boolean","types":["boolean"]},"name":{"type":"string","types":["string"]},"swaggerSchemaClass":{"type":"string","types":["string"]},"superType":{"type":"string","types":["string"]}},"types":["object"]},"queryParam":{"type":"boolean","types":["boolean"]},"uniqueCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"types":["array"]}},"types":["object"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/loadParamsOfEndpoint > /api/loadParamsOfEndpoint ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/loadParamsOfEndpoint":{"post":{"summary":"/api/loadParamsOfEndpoint","operationId":"https://app.akto.io/api/loadParamsOfEndpoint-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"],"required":["method","apiCollectionId","url"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"params":{"type":"array","items":{"type":"object","properties":{"sources":{"type":"object","properties":{"HAR":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}},"types":["object"]},"values":{"type":"object","properties":{"elements":{"type":"array","items":{"type":"string","types":["string"]},"types":["array"]}},"types":["object"]},"isPrivate":{"type":"boolean","types":["boolean"]},"responseCode":{"type":"integer","format":"int32","types":["integer"]},"duration":{"type":"integer","format":"int32","types":["integer"]},"minValue":{"type":"integer","format":"int32","types":["integer"]},"param":{"type":"string","types":["string"]},"subTypeString":{"type":"string","types":["string"]},"id":{"type":"object","properties":{"date":{"type":"string","types":["string"]},"timestamp":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"timestamp":{"type":"integer","format":"int32","types":["integer"]},"isUrlParam":{"type":"boolean","types":["boolean"]},"method":{"type":"string","types":["string"]},"strId":{"type":"string","types":["string"]},"isQueryParam":{"type":"boolean","types":["boolean"]},"maxValue":{"type":"integer","format":"int32","types":["integer"]},"count":{"type":"integer","format":"int32","types":["integer"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"sensitive":{"type":"boolean","types":["boolean"]},"url":{"type":"string","types":["string"]},"lastSeen":{"type":"integer","format":"int32","types":["integer"]},"publicCount":{"type":"integer","format":"int32","types":["integer"]},"isHeader":{"type":"boolean","types":["boolean"]},"collectionIds":{"type":"array","items":{"type":"integer","format":"int32","types":["integer"]},"types":["array"]},"domain":{"type":"string","types":["string"]},"subType":{"type":"object","properties":{"sensitiveAlways":{"type":"boolean","types":["boolean"]},"swaggerSchemaClass":{"type":"string","types":["string"]},"name":{"type":"string","types":["string"]},"superType":{"type":"string","types":["string"]}},"types":["object"]},"queryParam":{"type":"boolean","types":["boolean"]},"uniqueCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"types":["array"]}},"types":["object"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/createCollection > /api/createCollection ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/createCollection":{"post":{"summary":"/api/createCollection","operationId":"https://app.akto.io/api/createCollection-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"collectionName":{"type":"string","types":["string"]}},"types":["object"],"required":["collectionName"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"apiCollections":{"type":"array","items":{"type":"object","properties":{"hostName":{"type":"string","types":["string"]},"urlsCount":{"type":"integer","format":"int32","types":["integer"]},"runDependencyAnalyser":{"type":"boolean","types":["boolean"]},"displayName":{"type":"string","types":["string"]},"redact":{"type":"boolean","types":["boolean"]},"sseCallbackUrl":{"type":"string","types":["string"]},"description":{"type":"string","types":["string"]},"startTs":{"type":"integer","format":"int32","types":["integer"]},"mcpCollection":{"type":"boolean","types":["boolean"]},"type":{"type":"string","types":["string"]},"deactivated":{"type":"boolean","types":["boolean"]},"automated":{"type":"boolean","types":["boolean"]},"matchDependencyWithOtherCollections":{"type":"boolean","types":["boolean"]},"envType":{"type":"string","types":["string"]},"vxlanId":{"type":"integer","format":"int32","types":["integer"]},"tagsList":{"type":"string","types":["string"]},"userSetEnvType":{"type":"string","types":["string"]},"name":{"type":"string","types":["string"]},"genAICollection":{"type":"boolean","types":["boolean"]},"id":{"type":"integer","format":"int32","types":["integer"]},"isOutOfTestingScope":{"type":"boolean","types":["boolean"]},"sampleCollectionsDropped":{"type":"boolean","types":["boolean"]},"conditions":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"uningestedApiList":{"type":"string","types":["string"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/redactCollection > /api/redactCollection ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/redactCollection":{"post":{"summary":"/api/redactCollection","operationId":"https://app.akto.io/api/redactCollection-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"redacted":{"type":"boolean","types":["boolean"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["redacted","apiCollectionId"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"uningestedApiList":{"type":"string","types":["string"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/importDataFromOpenApiSpec > /api/importDataFromOpenApiSpec ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/importDataFromOpenApiSpec":{"post":{"summary":"/api/importDataFromOpenApiSpec","operationId":"https://app.akto.io/api/importDataFromOpenApiSpec-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openAPIString":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["openAPIString","apiCollectionId"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"openAPIString":{"type":"string","types":["string"]},"importType":{"type":"string","types":["string"]},"uploadDetails":{"type":"string","types":["string"]},"uploadId":{"type":"string","types":["string"]},"lastFetchedMethod":{"type":"string","types":["string"]},"apiInfoKeyList":{"type":"string","types":["string"]},"lastFetchedUrl":{"type":"string","types":["string"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/createCustomCollection > /api/createCustomCollection ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/createCustomCollection":{"post":{"summary":"/api/createCustomCollection","operationId":"https://app.akto.io/api/createCustomCollection-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"apiList":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"],"required":["method","apiCollectionId","url"]},"types":["array"]}},"types":["object"],"required":["apiList"]},"type":{"type":"string","types":["string"]},"operator":{"type":"string","types":["string"]}},"types":["object"],"required":["data","type","operator"]},"types":["array"]},"collectionName":{"type":"string","types":["string"]}},"types":["object"],"required":["conditions","collectionName"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"data":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"startTs":{"type":"integer","format":"int32","types":["integer"]},"_id":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"]},"changesCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"types":["array"]},"apiInfoList":{"type":"array","items":{"type":"object","properties":{"responseCodes":{"type":"array","items":{"type":"integer","format":"int32","types":["integer"]},"types":["array"]},"discoveredTimestamp":{"type":"integer","format":"int32","types":["integer"]},"sources":{"type":"object","properties":{"HAR":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}},"types":["object"]},"violations":{"type":"string","types":["string"]},"lastCalculatedTime":{"type":"integer","format":"int32","types":["integer"]},"lastTested":{"type":"integer","format":"int32","types":["integer"]},"description":{"type":"string","types":["string"]},"severityScore":{"type":"number","types":["number"]},"lastSeen":{"type":"integer","format":"int32","types":["integer"]},"actualAuthType":{"type":"array","items":{"type":"string","types":["string"]},"types":["array"]},"allAuthTypesFound":{"type":"array","items":{"type":"array","items":{"type":"string","types":["string"]},"types":["array"]},"types":["array"]},"collectionIds":{"type":"array","items":{"type":"integer","format":"int32","types":["integer"]},"types":["array"]},"isSensitive":{"type":"boolean","types":["boolean"]},"id":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"]},"riskScore":{"type":"number","types":["number"]},"apiType":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]}},"types":["object"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"apiCollections":{"type":"array","items":{"type":"object","properties":{"hostName":{"type":"string","types":["string"]},"urlsCount":{"type":"integer","format":"int32","types":["integer"]},"runDependencyAnalyser":{"type":"boolean","types":["boolean"]},"displayName":{"type":"string","types":["string"]},"redact":{"type":"boolean","types":["boolean"]},"sseCallbackUrl":{"type":"string","types":["string"]},"description":{"type":"string","types":["string"]},"mcpCollection":{"type":"boolean","types":["boolean"]},"startTs":{"type":"integer","format":"int32","types":["integer"]},"type":{"type":"string","types":["string"]},"deactivated":{"type":"boolean","types":["boolean"]},"urls":{"type":"string","types":["string"]},"automated":{"type":"boolean","types":["boolean"]},"matchDependencyWithOtherCollections":{"type":"boolean","types":["boolean"]},"vxlanId":{"type":"integer","format":"int32","types":["integer"]},"envType":{"type":"string","types":["string"]},"tagsList":{"type":"string","types":["string"]},"genAICollection":{"type":"boolean","types":["boolean"]},"userSetEnvType":{"type":"string","types":["string"]},"name":{"type":"string","types":["string"]},"id":{"type":"integer","format":"int32","types":["integer"]},"conditions":{"type":"array","items":{"type":"object","properties":{"apisList":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"type":{"type":"string","types":["string"]},"operator":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"sampleCollectionsDropped":{"type":"boolean","types":["boolean"]},"isOutOfTestingScope":{"type":"boolean","types":["boolean"]}},"types":["object"]},"types":["array"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"array","items":{"type":"object","properties":{"data":{"type":"object","properties":{"apiList":{"type":"array","items":{"type":"object","properties":{"method":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"url":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]}},"types":["object"]},"type":{"type":"string","types":["string"]},"operator":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"uningestedApiList":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]}}}}}}}}} ``` ## POST /api/deactivateCollections > /api/deactivateCollections ```json {"openapi":"3.0.1","info":{"title":"Akto","version":"1.0.0"},"paths":{"/api/deactivateCollections":{"post":{"summary":"/api/deactivateCollections","operationId":"https://app.akto.io/api/deactivateCollections-POST","parameters":[{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"},"description":"You can get this from Settings > Integrations > Akto APls > Generate token"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"apiCollections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"],"required":["id"]},"types":["array"]}},"types":["object"],"required":["apiCollections"]}}}},"responses":{"200":{"description":"description","headers":{"date":{"schema":{"type":"string","types":["string"]}},"content-length":{"schema":{"type":"integer","format":"int32","types":["integer"]}},"vary":{"schema":{"type":"string","types":["string"]}},"via":{"schema":{"type":"string","types":["string"]}},"access-control-allow-origin":{"schema":{"type":"string","types":["string"]}},"access-control-allow-credentials":{"schema":{"type":"string","types":["string"]}},"content-type":{"schema":{"type":"string","types":["string"]}},"alt-svc":{"schema":{"type":"string","types":["string"]}},"cache-control":{"schema":{"type":"string","types":["string"]}},"content-language":{"schema":{"type":"string","types":["string"]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"sensitiveUrlsInResponse":{"type":"integer","format":"int32","types":["integer"]},"shadowApisCount":{"type":"integer","format":"int32","types":["integer"]},"redacted":{"type":"boolean","types":["boolean"]},"riskScoreOfCollectionsMap":{"type":"string","types":["string"]},"apiCount":{"type":"integer","format":"int32","types":["integer"]},"lastTrafficSeenMap":{"type":"string","types":["string"]},"uningestedApiCountMap":{"type":"string","types":["string"]},"endpointsFromConditions":{"type":"string","types":["string"]},"sensitiveUnauthenticatedEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"endpointsListFromConditions":{"type":"string","types":["string"]},"apiStatsStart":{"type":"string","types":["string"]},"criticalEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"deactivatedHostnameCountMap":{"type":"string","types":["string"]},"countForHostnameDeactivatedCollections":{"type":"string","types":["string"]},"testedEndpointsMaps":{"type":"string","types":["string"]},"apiList":{"type":"string","types":["string"]},"severityInfo":{"type":"string","types":["string"]},"sensitiveSubtypesInCollection":{"type":"string","types":["string"]},"hasUsageEndpoints":{"type":"boolean","types":["boolean"]},"countForUningestedApis":{"type":"string","types":["string"]},"apiCollectionId":{"type":"integer","format":"int32","types":["integer"]},"timerInfo":{"type":"string","types":["string"]},"response":{"type":"object","properties":{"apiCount":{"type":"integer","format":"int32","types":["integer"]}},"types":["object"]},"apiCollections":{"type":"array","items":{"type":"object","properties":{"hostName":{"type":"string","types":["string"]},"urlsCount":{"type":"integer","format":"int32","types":["integer"]},"runDependencyAnalyser":{"type":"boolean","types":["boolean"]},"displayName":{"type":"string","types":["string"]},"redact":{"type":"boolean","types":["boolean"]},"sseCallbackUrl":{"type":"string","types":["string"]},"description":{"type":"string","types":["string"]},"startTs":{"type":"integer","format":"int32","types":["integer"]},"mcpCollection":{"type":"boolean","types":["boolean"]},"type":{"type":"string","types":["string"]},"deactivated":{"type":"boolean","types":["boolean"]},"automated":{"type":"boolean","types":["boolean"]},"matchDependencyWithOtherCollections":{"type":"boolean","types":["boolean"]},"envType":{"type":"array","items":{"type":"object","properties":{"keyName":{"type":"string","types":["string"]},"lastUpdatedTs":{"type":"integer","format":"int32","types":["integer"]},"source":{"type":"string","types":["string"]},"value":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"vxlanId":{"type":"integer","format":"int32","types":["integer"]},"tagsList":{"type":"array","items":{"type":"object","properties":{"keyName":{"type":"string","types":["string"]},"lastUpdatedTs":{"type":"integer","format":"int32","types":["integer"]},"source":{"type":"string","types":["string"]},"value":{"type":"string","types":["string"]}},"types":["object"]},"types":["array"]},"genAICollection":{"type":"boolean","types":["boolean"]},"name":{"type":"string","types":["string"]},"userSetEnvType":{"type":"string","types":["string"]},"id":{"type":"integer","format":"int32","types":["integer"]},"isOutOfTestingScope":{"type":"boolean","types":["boolean"]},"conditions":{"type":"string","types":["string"]},"sampleCollectionsDropped":{"type":"boolean","types":["boolean"]}},"types":["object"]},"types":["array"]},"mcpDataCount":{"type":"integer","format":"int32","types":["integer"]},"usersCollectionList":{"type":"object","properties":{"NUMBER":{"type":"string","types":["string"]}},"types":["object"]},"allUsersCollections":{"type":"string","types":["string"]},"apiStatsEnd":{"type":"string","types":["string"]},"conditions":{"type":"string","types":["string"]},"highRiskThirdPartyEndpointsCount":{"type":"integer","format":"int32","types":["integer"]},"uningestedApiList":{"type":"string","types":["string"]}},"types":["object"]}}}}}}}}} ``` ## Approve and ingest a Swagger file upload > Pushes approved records from the specified Swagger/OpenAPI upload to Kafka (topic \`akto.api.logs\`) for async ingestion into the Akto API inventory. Only endpoints matching the chosen \`importType\` are included.\ > \ > Source: \`OpenApiAction.importFile()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/importSwaggerLogs":{"post":{"summary":"Approve and ingest a Swagger file upload","description":"Pushes approved records from the specified Swagger/OpenAPI upload to Kafka (topic `akto.api.logs`) for async ingestion into the Akto API inventory. Only endpoints matching the chosen `importType` are included.\n\nSource: `OpenApiAction.importFile()`","operationId":"importSwaggerLogs","tags":["OpenAPI / Swagger"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uploadId","importType"],"properties":{"uploadId":{"type":"string","description":"ID of the Swagger file upload to ingest."},"importType":{"type":"string","enum":["ONLY_SUCCESSFUL_APIS","ALL_APIS"],"description":"Whether to ingest only successfully parsed endpoints (`ONLY_SUCCESSFUL_APIS`) or all endpoints including those with non-fatal parse errors (`ALL_APIS`)."}}}}}},"responses":{"200":{"description":"Import queued successfully. Ingestion happens asynchronously via Kafka."},"400":{"description":"`uploadId` is not found or records cannot be read."}}}}}} ``` ## Import Imperva schema > Parses a raw Imperva JSON string (max 10 MB), creates or finds an API collection named after the extracted hostname, and pushes the parsed traffic asynchronously to Kafka for ingestion into the API inventory. \`generateMultipleSamples\` controls whether multiple sample request/response pairs are generated per endpoint.\ > \ > Source: \`ImpervaImportAction.execute()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/importImpervaSchema":{"post":{"summary":"Import Imperva schema","description":"Parses a raw Imperva JSON string (max 10 MB), creates or finds an API collection named after the extracted hostname, and pushes the parsed traffic asynchronously to Kafka for ingestion into the API inventory. `generateMultipleSamples` controls whether multiple sample request/response pairs are generated per endpoint.\n\nSource: `ImpervaImportAction.execute()`","operationId":"importImpervaSchema","tags":["Imperva Import"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["impervaString"],"properties":{"impervaString":{"type":"string","description":"Raw Imperva JSON string. Maximum size is 10 MB."},"generateMultipleSamples":{"type":"boolean","default":false,"description":"If `true`, generates multiple sample messages per endpoint instead of just one."}}}}}},"responses":{"200":{"description":"Import initiated successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable success message."},"actionErrors":{"type":"array","items":{"type":"string"}}}}}}},"400":{"description":"`impervaString` is null/empty or exceeds the 10 MB size limit."}}}}}} ``` ## Import APIs from a URL > Creates an API collection named after the URL's hostname (tagged as GenAI), then fires an HTTP request to the given URL asynchronously and ingests the response via Kafka. Omit \`requestBody\` to use GET; provide it to send a POST with that body. An optional \`testRoleId\` enables authenticated fetching using a pre-configured test role.\ > \ > Source: \`AgentImportAction.importFromUrl()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/importFromUrl":{"post":{"summary":"Import APIs from a URL","description":"Creates an API collection named after the URL's hostname (tagged as GenAI), then fires an HTTP request to the given URL asynchronously and ingests the response via Kafka. Omit `requestBody` to use GET; provide it to send a POST with that body. An optional `testRoleId` enables authenticated fetching using a pre-configured test role.\n\nSource: `AgentImportAction.importFromUrl()`","operationId":"importFromUrl","tags":["URL Import"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Full URL to fetch. The hostname is used as the collection name."},"testRoleId":{"type":"string","description":"Optional ObjectId hex of the test role to use for authentication when fetching the URL."},"requestBody":{"type":"string","description":"Optional POST body. If set, the URL is fetched with HTTP POST using this as the body. Omit to use GET."}}}}}},"responses":{"200":{"description":"Import initiated. Ingestion happens asynchronously."},"400":{"description":"`url` is null or empty."}}}}}} ``` ## Add or update Postman API key > Upserts the Postman credential (API key and workspace ID) for the current account in \`third\_party\_access\`. Used by subsequent Postman integration calls (\`createPostmanApi\`, \`savePostmanCollection\`).\ > \ > Source: \`PostmanAction.addOrUpdateApiKey()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/addOrUpdatePostmanCred":{"post":{"summary":"Add or update Postman API key","description":"Upserts the Postman credential (API key and workspace ID) for the current account in `third_party_access`. Used by subsequent Postman integration calls (`createPostmanApi`, `savePostmanCollection`).\n\nSource: `PostmanAction.addOrUpdateApiKey()`","operationId":"addOrUpdatePostmanCred","tags":["Postman"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["api_key","workspace_id"],"properties":{"api_key":{"type":"string","description":"Postman API key."},"workspace_id":{"type":"string","description":"Postman workspace UUID."}}}}}},"responses":{"200":{"description":"Credentials saved successfully."}}}}}} ``` ## Export a collection to Postman > Builds an OpenAPI spec from the stored sample data for the given collection and pushes it to the Postman API asynchronously using the API key stored via \`addOrUpdatePostmanCred\`. An optional \`apiInfoKeyList\` restricts the export to a specific subset of endpoints; if omitted, the entire collection is exported.\ > \ > Source: \`PostmanAction.createPostmanApi()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/createPostmanApi":{"post":{"summary":"Export a collection to Postman","description":"Builds an OpenAPI spec from the stored sample data for the given collection and pushes it to the Postman API asynchronously using the API key stored via `addOrUpdatePostmanCred`. An optional `apiInfoKeyList` restricts the export to a specific subset of endpoints; if omitted, the entire collection is exported.\n\nSource: `PostmanAction.createPostmanApi()`","operationId":"createPostmanApi","tags":["Postman"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiCollectionId"],"properties":{"apiCollectionId":{"type":"integer","description":"ID of the API collection to export."},"apiInfoKeyList":{"type":"array","description":"Optional list of specific endpoints to export. If omitted the entire collection is exported.","items":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"apiCollectionId":{"type":"integer"}}}}}}}}},"responses":{"200":{"description":"Export queued successfully. Upload to Postman happens asynchronously."}}}}}} ``` ## Import a Postman collection into Akto > Fetches the specified Postman collection via the stored Postman API key, converts it through Akto's Node.js conversion service, and stores the resulting APISpec document in MongoDB.\ > \ > Source: \`PostmanAction.savePostmanCollection()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/savePostmanCollection":{"post":{"summary":"Import a Postman collection into Akto","description":"Fetches the specified Postman collection via the stored Postman API key, converts it through Akto's Node.js conversion service, and stores the resulting APISpec document in MongoDB.\n\nSource: `PostmanAction.savePostmanCollection()`","operationId":"savePostmanCollection","tags":["Postman"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["postmanCollectionId","apiCollectionId"],"properties":{"postmanCollectionId":{"type":"string","description":"Postman collection UUID (found in the Postman share URL)."},"apiCollectionId":{"type":"integer","description":"Akto collection ID to associate with the imported Postman collection."}}}}}},"responses":{"200":{"description":"Collection imported and APISpec stored."}}}}}} ``` ## Approve and ingest a Postman file upload > Pushes approved records from the specified Postman file upload to Kafka (topic \`akto.api.logs\`) for async ingestion. Only endpoints matching the chosen \`importType\` are included.\ > \ > Source: \`PostmanAction.importFile()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/ingestPostman":{"post":{"summary":"Approve and ingest a Postman file upload","description":"Pushes approved records from the specified Postman file upload to Kafka (topic `akto.api.logs`) for async ingestion. Only endpoints matching the chosen `importType` are included.\n\nSource: `PostmanAction.importFile()`","operationId":"ingestPostman","tags":["Postman"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uploadId","importType"],"properties":{"uploadId":{"type":"string","description":"ID of the Postman file upload to ingest."},"importType":{"type":"string","enum":["ONLY_SUCCESSFUL_APIS","ALL_APIS"],"description":"Whether to ingest only successfully parsed endpoints or all endpoints including those with non-fatal parse errors."}}}}}},"responses":{"200":{"description":"Import queued successfully."}}}}}} ``` ## Mark a Postman upload for deletion > Sets \`markedForDeletion: true\` on the specified upload record so it is excluded from future import log listings.\ > \ > Source: \`PostmanAction.markImportForDeletion()\` ```json {"openapi":"3.0.1","info":{"title":"AktoSwagger","version":"1.0.0"},"paths":{"/api/deletePostmanImportLogs":{"post":{"summary":"Mark a Postman upload for deletion","description":"Sets `markedForDeletion: true` on the specified upload record so it is excluded from future import log listings.\n\nSource: `PostmanAction.markImportForDeletion()`","operationId":"deletePostmanImportLogs","tags":["Postman"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uploadId"],"properties":{"uploadId":{"type":"string","description":"ID of the Postman upload to mark for deletion."}}}}}},"responses":{"200":{"description":"Upload marked for deletion."}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.akto.io/api-reference/discovery/modify-data.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.