# API reference

You will need the following inputs for each of the API endpoints:

* <mark style="color:purple;">`YOUR_API_KEY`</mark> : Go to My account > Settings > Integrations and fetch API key under Akto API. You should pass it with the header `X-API-KEY`.
* <mark style="color:purple;">`URL`</mark> : This is the url of your Akto dashboard.

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchTestRunResultDetails" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchDataTypes" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAffectedEndpoints" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchTagConfigs" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/loadContent" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/retrieveAllCollectionTests" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchPostmanWorkspaces" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchQuickStartPageState" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/importDataFromPostmanFile" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAPICollection" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAllSubCategories" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchNewParametersTrend" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchFilters" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchTestRoles" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchSubTypeCountMap" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchIssueFromTestRunResultDetails" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchSearchTestResults" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchSensitiveSampleData" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/loadParamsOfEndpoint" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/getAllCollections" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/updateIssueStatus" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAktoGptConfig" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchDataTypeNames" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/loadRecentEndpoints" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAllIssues" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchIssuesFromCollections" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/addTestRoles" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchTestingRunResults" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAllMarketplaceSubcategories" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchSensitiveParamsForEndpoints" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/getPostmanCredential" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/importPostmanWorkspace" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchChanges" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/addSensitiveField" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchWorkflowTests" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/updateTestRoles" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/loadSensitiveParameters" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchAuthMechanismData" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/stopAllTests" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchCustomAuthTypes" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchEndpointTrafficData" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/saveAktoDataType" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchTestingRunResultSummaries" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchSampleData" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchTestingSources" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}

{% openapi src="/files/8Uamph0abkuPy72h5XBP" path="/api/fetchActiveLoaders" method="post" %}
[AktoSwagger.json](https://2916937215-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FRc4KTKGprZI2sPWKoaLe%2Fuploads%2Fgit-blob-fe71d03e91a50a9fdf7565f6ca2424d19caa37e7%2FAktoSwagger.json?alt=media)
{% endopenapi %}


---

# Agent Instructions: 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:

```
GET https://docs.akto.io/api-reference/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.