Modify Data
1
POST /api/startTest
Start a new scan run on the selected agentic collections or agentic components.
2
POST /api/stopTest
Stop an ongoing scan run before it completes.
3
POST /api/addTestRoles
Add probe roles for red teaming execution.
4
POST /api/stopAllTests
Stop all ongoing scan runs.
5
POST /api/updateTestRoles
Update probe role configurations.
6
POST /api/modifyTestingRunConfig
Modifies an existing scanning run configuration including probe suites, subcategories, schedule, concurrency, alerts, role, and auto-ticketing settings.
7
POST /api/addAuthMechanism
Adds a new authentication mechanism (hardcoded token, login flow, sample data, or TLS) for Agentic Component scanning.
8
POST /api/triggerLoginSteps
Executes login flow steps and returns step-by-step responses. Used to validate login sequences before saving an auth mechanism.
9
POST /api/createTestSuite
Creates a new custom probe suite with a given name and list of probe subcategories.
10
POST /api/modifyTestSuite
Updates an existing custom probe suite's name and/or subcategories.
11
POST /api/deleteTestSuite
Deletes a custom probe suite by its hex ID.
12
POST /api/bulkUpdateTestResultsSeverity
Bulk-updates the severity level of selected scan results across all related collections.
13
POST /api/deleteTestRuns
Deletes the specified scan runs and schedules a background job to clean up associated results and summaries.
14
POST /api/deleteTestRunsFromSummaries
Deletes scan data (results and summaries) identified by scanning run result summary IDs via a background job.
15
POST /api/changeStatus
Changes the active/inactive status of a custom webhook and updates its associated scheduled job.
16
POST /api/runOnce
Triggers an immediate one-time asynchronous execution of a custom webhook.
17
POST /api/runTestOnboarding
Runs the onboarding probe suite against a specified collection with provided auth credentials.
18
POST /api/saveDefaultPayload
Saves or updates a default payload pattern for a domain, recording the creator and timestamps.
19
POST /api/saveReplaceDetails
Saves key-value replacement pairs for a specific Agentic component, used in dependency flow scanning.
20
POST /api/saveGlobalVars
Saves global host variable mappings for dependency flow scanning.
21
POST /api/invokeDependencyTable
Asynchronously invokes the dependency graph build job for the specified collections.
22
POST /api/createWorkflowTest
Creates a new workflow scan with a node/edge graph and associated node details.
23
POST /api/editWorkflowTest
Updates the nodes, edges, and node details of an existing workflow scan.
24
POST /api/setWorkflowTestState
Changes the state of a workflow scan (e.g. DRAFT → PUBLISHED → INACTIVE).
25
POST /api/editWorkflowNodeDetails
Updates the details of a single node within a workflow scan.
26
POST /api/deleteScheduledWorkflowTests
Stops all scheduled or running scanning runs for a given workflow scan.
27
POST /api/uploadWorkflowJson
Imports a workflow scan from a JSON string, creating a new workflow scan with a fresh ID.
28
POST /api/addTestLibrary
Adds a custom GitHub probe library to the account and clones YAML probe templates from it immediately.
29
POST /api/removeTestLibrary
Removes a custom probe library and deletes all CUSTOM-sourced templates loaded from it.
30
POST /api/syncCustomLibrary
Re-syncs YAML templates from a previously added custom probe library repository.
31
POST /api/syncAllDefaultTestLibraries
Triggers an async sync of all default Akto probe libraries from GitHub for the current account.
32
POST /api/saveTestEditorFile
Saves a custom YAML probe template file from the Agentic Playground.
33
POST /api/saveCommonTestTemplate
Saves or updates a common reusable probe template.
34
POST /api/runTestForGivenTemplate
Runs a probe for a given YAML template against a specified Agentic component from the Agentic Playground.
35
POST /api/saveTestRoleMeta
Saves metadata and configuration for a scan role.
36
POST /api/deleteTestRole
Deletes a scan role by ID.
37
POST /api/deleteAuthFromRole
Removes an authentication configuration from a scan role.
38
POST /api/updateAuthInRole
Updates an existing authentication configuration within a scan role.
39
POST /api/addAuthToRole
Adds a new authentication configuration to a scan role.
40
POST /api/triggerSingleLoginFlow
Triggers a single login flow step and returns the response, used to validate auth sequences.
41
POST /api/addScript
Inserts a new JavaScript scan script for a specified script type (PRE_TEST, PRE_REQUEST, POST_REQUEST, POST_TEST).
42
POST /api/updateScript
Replaces the JavaScript content of an existing scan script identified by its ID.
43
POST /api/updateAccessMatrixTask
Update the role name and frequency for an existing Access Matrix task.
44
POST /api/createMultipleAccessMatrixTasks
Create or upsert an Access Matrix task for a given role with default schedule settings (24h frequency).
45
POST /api/deleteAccessMatrix
Delete all access matrix data for a given role, including task info and URL-to-role mappings.
46
POST /api/deleteAccessMatrixTask
Delete a single Access Matrix task by its hex ID.
application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsSample description
6464783658e3a17b14ddfa67description
Sample description
SUCCESSPOST /api/stopTest HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"testingRunHexId": "6464783658e3a17b14ddfa67"
}description
{
"status": "SUCCESS"
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsSample description
nullnullfalse0nulldescription
Sample description
6464783658e3a17b14ddfa67POST /api/startTest HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"apiCollectionIds": [
1
],
"testName": "null",
"testType": "null",
"recurringDaily": false,
"startTimestamp": 0,
"overriddenTestAppUrl": "null"
}description
{
"testingRunHexId": "6464783658e3a17b14ddfa67"
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsSample description
GUESTdescription
Sample description
nullGUESTnullPOST /api/addTestRoles HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 108
{
"roleName": "GUEST",
"orConditions": {
"predicates": [
{
"type": "CONTAINS",
"value": "api/user/"
}
],
"operator": "OR"
}
}description
{
"testRoles": "null",
"roleName": "GUEST",
"andConditions": "null",
"selectedRole": {
"createdBy": "ankush@akto.io",
"authMechanism": "null",
"name": "GUEST",
"lastUpdatedTs": 1684477847,
"id": {
"date": "2023-05-19T12:00:47",
"timestamp": 1684477847
},
"endpointLogicalGroupId": {
"date": "2023-05-19T12:00:47",
"timestamp": 1684477847
},
"createdTs": 1684477847,
"endpointLogicalGroup": {
"groupName": "GUEST_endpoint-logical-group",
"createdBy": "ankush@akto.io",
"testingEndpoints": {
"andConditions": "null",
"type": "LOGICAL_GROUP",
"orConditions": {
"predicates": [
{
"type": "CONTAINS",
"value": "api/user/"
}
],
"operator": "OR"
}
},
"id": {
"date": "2023-05-19T12:00:47",
"timestamp": 1684477847
},
"updatedTs": 1684477847,
"createdTs": 1684477847
}
},
"orConditions": {
"predicates": [
{
"type": "CONTAINS",
"value": "api/user/"
}
],
"operator": "OR"
}
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsSample description
description
Sample description
nullnullnullnullnull0falsenullnullnullfalsenull0null00nullPOST /api/stopAllTests HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}description
{
"metadata": "null",
"testingRunResults": "null",
"testingRunResultSummaries": "null",
"runIssues": "null",
"selectedTests": "null",
"maxConcurrentRequests": 0,
"recurringDaily": false,
"workflowTest": "null",
"authMechanism": "null",
"testingRunResult": "null",
"fetchCicd": false,
"testingRun": "null",
"testRunTime": 0,
"testingRunHexId": "null",
"endTimestamp": 0,
"startTimestamp": 0,
"testName": "null"
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsSample description
MEMBERdescription
Sample description
nullMEMBERnullnullPOST /api/updateTestRoles HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"roleName": "MEMBER",
"orConditions": {
"predicates": [
{
"type": "CONTAINS",
"value": "api-2"
}
],
"operator": "OR"
}
}description
{
"testRoles": "null",
"roleName": "MEMBER",
"andConditions": "null",
"selectedRole": "null",
"orConditions": {
"predicates": [
{
"type": "CONTAINS",
"value": "api-2"
}
],
"operator": "OR"
}
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsID of the testing run config to modify.
101Testing run configuration updated successfully.
Empty response body on success.
POST /api/modifyTestingRunConfig HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 335
{
"testingRunConfigId": 101,
"editableTestingRunConfig": {
"testSuiteIds": [
"suite-abc",
"suite-xyz"
],
"subCategoryList": [
"BOLA",
"SQLi"
],
"roleId": "role-001",
"appUrlOverride": "https://staging.example.com",
"maxConcurrentRequests": 5,
"testRunTime": 3600,
"sendAlerts": true,
"recurringDaily": false,
"continuousTesting": false,
"autoTicketingDetails": {}
}
}Testing run configuration updated successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsAuthentication type. One of: HARDCODED, LOGIN_REQUEST, SAMPLE_DATA, TLS_AUTH.
HARDCODEDAuthentication mechanism saved successfully.
Empty response body on success.
POST /api/addAuthMechanism HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 302
{
"type": "HARDCODED",
"authParamData": [
{
"where": "HEADER",
"key": "Authorization",
"value": "Bearer eyJhbGci...",
"showHeader": true
}
],
"requestData": [
{
"url": "https://example.com/api/login",
"method": "POST",
"body": "{\"username\":\"admin\",\"password\":\"secret\"}",
"headers": {
"Content-Type": "application/json"
}
}
]
}Authentication mechanism saved successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsMust be LOGIN_REQUEST.
LOGIN_REQUESTOptional name of mini-testing service to execute the login steps.
mini-service-1Returns responses for each login flow step.
POST /api/triggerLoginSteps HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 328
{
"type": "LOGIN_REQUEST",
"authParamData": [
{
"where": "HEADER",
"key": "Authorization",
"value": "Bearer {{token}}"
}
],
"requestData": [
{
"url": "https://example.com/api/login",
"method": "POST",
"body": "{\"username\":\"admin\",\"password\":\"secret\"}",
"headers": {
"Content-Type": "application/json"
}
}
],
"miniTestingServiceName": "mini-service-1"
}Returns responses for each login flow step.
{
"responses": [
{
"statusCode": 200,
"body": "{\"token\":\"eyJhbGci...\"}",
"headers": {}
}
]
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsDisplay name for the new test suite. A numeric suffix is appended if the name already exists.
My OWASP SuiteList of test subcategory identifiers to include in this suite.
["BOLA","SQLi","XSS"]Test suite created successfully.
Empty response body on success.
POST /api/createTestSuite HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"testSuiteName": "My OWASP Suite",
"subCategoryList": [
"BOLA",
"SQLi",
"XSS"
]
}Test suite created successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex-encoded ObjectId of the test suite to modify.
64b1f2c3a4e5d6f7b8c9d0e1New display name for the test suite.
Updated OWASP SuiteReplacement list of test subcategory identifiers.
["BOLA","BFLA"]Test suite updated successfully.
Empty response body on success.
POST /api/modifyTestSuite HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"testSuiteHexId": "64b1f2c3a4e5d6f7b8c9d0e1",
"testSuiteName": "Updated OWASP Suite",
"subCategoryList": [
"BOLA",
"BFLA"
]
}Test suite updated successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex-encoded ObjectId of the test suite to delete.
64b1f2c3a4e5d6f7b8c9d0e1Test suite deleted successfully.
Empty response body on success.
POST /api/deleteTestSuite HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"testSuiteHexId": "64b1f2c3a4e5d6f7b8c9d0e1"
}Test suite deleted successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex IDs of the test results to update.
["64b1f2c3a4e5d6f7b8c9d0e1","64b1f2c3a4e5d6f7b8c9d0e2"]New severity level. One of: CRITICAL, HIGH, MEDIUM, LOW.
HIGHSeverity updated across all related collections.
Empty response body on success.
POST /api/bulkUpdateTestResultsSeverity HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 111
{
"testingRunResultHexIds": [
"64b1f2c3a4e5d6f7b8c9d0e1",
"64b1f2c3a4e5d6f7b8c9d0e2"
],
"severityToBeUpdated": "HIGH"
}Severity updated across all related collections.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex-encoded ObjectIds of the test runs to delete.
["64a0e1b2c3d4e5f6a7b8c9d0","64a0e1b2c3d4e5f6a7b8c9d1"]Test runs deleted and cleanup job enqueued.
Empty response body on success.
POST /api/deleteTestRuns HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 70
{
"testRunIds": [
"64a0e1b2c3d4e5f6a7b8c9d0",
"64a0e1b2c3d4e5f6a7b8c9d1"
]
}Test runs deleted and cleanup job enqueued.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex-encoded ObjectIds of the testing run result summaries to delete.
["64b1f2c3a4e5d6f7b8c9d0e1","64b1f2c3a4e5d6f7b8c9d0e2"]Deletion job enqueued for the specified summaries.
Empty response body on success.
POST /api/deleteTestRunsFromSummaries HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"latestSummaryIds": [
"64b1f2c3a4e5d6f7b8c9d0e1",
"64b1f2c3a4e5d6f7b8c9d0e2"
]
}Deletion job enqueued for the specified summaries.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsID of the custom webhook to update.
7New status. One of: ACTIVE, INACTIVE.
ACTIVEWebhook status updated successfully.
Empty response body on success.
POST /api/changeStatus HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"id": 7,
"activeStatus": "ACTIVE"
}Webhook status updated successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsID of the custom webhook to execute.
7Webhook execution triggered asynchronously.
Empty response body; execution happens asynchronously.
POST /api/runOnce HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8
{
"id": 7
}Webhook execution triggered asynchronously.
{}FULLOnboarding tests completed
No content
POST /api/runTestOnboarding HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"testType": "FULL"
}Onboarding tests completed
No content
application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsDomain name to associate the payload with.
example.comJSON or text payload pattern to save as the default for this domain.
{"username":"test","password":"test"}Payload saved. Returns the updated DefaultPayload object.
POST /api/saveDefaultPayload HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"domain": "example.com",
"pattern": "{\"username\":\"test\",\"password\":\"test\"}"
}Payload saved. Returns the updated DefaultPayload object.
{
"defaultPayload": {
"domain": "example.com",
"pattern": "{\"username\":\"test\",\"password\":\"test\"}",
"creator": "alice@example.com",
"createdTs": 1712300000,
"updatedTs": 1712305000
}
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsID of the API collection containing the endpoint.
1001URL path of the API endpoint.
/api/users/{id}HTTP method of the endpoint.
GETReplacement details saved successfully.
Empty response body on success.
POST /api/saveReplaceDetails HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"apiCollectionId": 1001,
"url": "/api/users/{id}",
"method": "GET",
"kvPairs": [
{
"key": "id",
"value": "{{userId}}"
}
]
}Replacement details saved successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsGlobal host variable mappings saved successfully.
Empty response body on success.
POST /api/saveGlobalVars HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 102
{
"modifyHostDetails": [
{
"currentHost": "api.internal.example.com",
"newHost": "api.staging.example.com"
}
]
}Global host variable mappings saved successfully.
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsCollection IDs to invoke the dependency graph for.
[1001,1002]If true, APIs are from source code analysis and the original collection is used instead of creating a temp one.
falseDependency graph build job enqueued.
ID of the temporary collection created to hold dependency flow data.
2001POST /api/invokeDependencyTable HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"apiCollectionIds": [
1001,
1002
],
"sourceCodeApis": false
}Dependency graph build job enqueued.
{
"newCollectionId": 2001
}ID of the API collection this workflow test belongs to
1748293710List of React Flow node IDs in the workflow graph
["node-1","node-2","node-3"]List of React Flow edge IDs connecting workflow nodes
["edge-1-2","edge-2-3"]Initial workflow test state
DRAFTPossible values: Workflow test created successfully
Forbidden
Unprocessable — nodes map is null or a node failed validation
POST /api/createWorkflowTest HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"apiCollectionId": 1748293710,
"nodes": [
"node-1",
"node-2",
"node-3"
],
"edges": [
"edge-1-2",
"edge-2-3"
],
"mapNodeIdToWorkflowNodeDetails": {
"node-1": {
"apiInfoKey": {
"apiCollectionId": 1748293710,
"url": "https://api.example.com/v1/login",
"method": "POST"
},
"type": "API",
"requestPayload": "{\"username\":\"admin@example.com\",\"password\":\"[REDACTED]\"}"
}
},
"state": "DRAFT"
}{
"workflowTests": [
{
"id": 1766398064,
"apiCollectionId": 1748293710,
"author": "admin@example.com",
"editor": "admin@example.com",
"createdTimestamp": 1766398064,
"lastEdited": 1766398064,
"nodes": [
"text"
],
"edges": [
"text"
],
"state": "DRAFT"
}
]
}Workflow test ID
1766398064["node-1","node-2","node-3"]["edge-1-2","edge-2-3"]Workflow test updated
Forbidden
Unprocessable — workflow test not found
POST /api/editWorkflowTest HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 233
{
"id": 1766398064,
"nodes": [
"node-1",
"node-2",
"node-3"
],
"edges": [
"edge-1-2",
"edge-2-3"
],
"mapNodeIdToWorkflowNodeDetails": {
"node-1": {
"apiInfoKey": {
"apiCollectionId": 1748293710,
"url": "https://api.example.com/v1/login",
"method": "POST"
}
}
}
}{
"workflowTests": [
{}
]
}1766398064PUBLISHEDPossible values: State updated
Forbidden
Unprocessable — workflow test not found
POST /api/setWorkflowTestState HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"id": 1766398064,
"state": "PUBLISHED"
}{
"workflowTests": [
{}
]
}Workflow test ID
1766398064Must contain exactly one entry: the node ID to update → updated WorkflowNodeDetails
{"node-2":{"apiInfoKey":{"apiCollectionId":1748293710,"url":"https://api.example.com/v1/profile","method":"GET"},"type":"API"}}Node details updated
Forbidden
Unprocessable — workflow test not found or node ID mismatch
POST /api/editWorkflowNodeDetails HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 178
{
"id": 1766398064,
"mapNodeIdToWorkflowNodeDetails": {
"node-2": {
"apiInfoKey": {
"apiCollectionId": 1748293710,
"url": "https://api.example.com/v1/profile",
"method": "GET"
},
"type": "API"
}
}
}{
"workflowTests": [
{}
]
}1766398064Scheduled/running tests stopped (state set to STOPPED)
Forbidden
POST /api/deleteScheduledWorkflowTests HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"workflowTestId": 1766398064
}{}JSON string of a WorkflowTest (as produced by downloadWorkflowAsJson)
{"apiCollectionId":1748293710,"nodes":["node-1","node-2"],"edges":["edge-1-2"],"state":"PUBLISHED","mapNodeIdToWorkflowNodeDetails":{"node-1":{"type":"API"}}}Target API collection for the imported workflow
1748293710Workflow test imported successfully
Unprocessable — invalid JSON
POST /api/uploadWorkflowJson HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 234
{
"workflowTestJson": "{\"apiCollectionId\":1748293710,\"nodes\":[\"node-1\",\"node-2\"],\"edges\":[\"edge-1-2\"],\"state\":\"PUBLISHED\",\"mapNodeIdToWorkflowNodeDetails\":{\"node-1\":{\"type\":\"API\"}}}",
"apiCollectionId": 1748293710
}{
"workflowTests": [
{}
]
}GitHub repository URL containing Akto YAML test templates
https://github.com/example-org/custom-akto-testsTest library added and templates synced
Forbidden
Unprocessable — repository URL empty or library already exists
POST /api/addTestLibrary HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"repositoryUrl": "https://github.com/example-org/custom-akto-tests"
}{}https://github.com/example-org/custom-akto-testsTest library and its templates removed
Forbidden
Unprocessable — repository URL empty
POST /api/removeTestLibrary HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"repositoryUrl": "https://github.com/example-org/custom-akto-tests"
}{}https://github.com/example-org/custom-akto-testsCustom library re-synced
Forbidden
Unprocessable — repository URL empty or library not found
POST /api/syncCustomLibrary HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"repositoryUrl": "https://github.com/example-org/custom-akto-tests"
}{}Sync job scheduled asynchronously
Forbidden
POST /api/syncAllDefaultTestLibraries HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{}Full YAML content of the test template
id: BOLA_TEST_CUSTOM info: name: Custom BOLA Test description: Tests for BOLA vulnerability details: Checks if user A can access user B resources impact: HIGH category: name: BOLA shortName: BOLA displayName: Broken Object Level Authorization subCategory: BOLA_TEST_CUSTOM severity: HIGH tags: - OWASP_TOP_10 api_selection_filters: method: eq: GET execute: type: single requests: - req: - modify_url: replace_auth_header: true validate: response_code: eq: 200Existing test ID to update. If null or different from the content's id, a new template is inserted.
BOLA_TEST_CUSTOMTest template saved
The resolved unique test ID (may differ from content id if a conflict was found)
BOLA_TEST_CUSTOMThe normalized YAML content that was saved (with resolved id and name)
id: BOLA_TEST_CUSTOM info: name: Custom BOLA Test ...Forbidden
Unprocessable — invalid YAML, missing info keys, or built-in template conflict
POST /api/saveTestEditorFile HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 606
{
"content": "id: BOLA_TEST_CUSTOM\ninfo:\n name: Custom BOLA Test\n description: Tests for BOLA vulnerability\n details: Checks if user A can access user B resources\n impact: HIGH\n category:\n name: BOLA\n shortName: BOLA\n displayName: Broken Object Level Authorization\n subCategory: BOLA_TEST_CUSTOM\n severity: HIGH\n tags:\n - OWASP_TOP_10\napi_selection_filters:\n method:\n eq: GET\nexecute:\n type: single\n requests:\n - req:\n - modify_url:\n replace_auth_header: true\nvalidate:\n response_code:\n eq: 200",
"originalTestId": "BOLA_TEST_CUSTOM"
}{
"finalTestId": "BOLA_TEST_CUSTOM",
"content": "id: BOLA_TEST_CUSTOM\ninfo:\n name: Custom BOLA Test\n ..."
}YAML content with wordLists definitions
wordLists: userIds: - "1" - "2" - "100" sensitiveEndpoints: - /api/admin - /api/internalCommon template saved
Forbidden
Unprocessable — invalid YAML or empty/null wordLists
POST /api/saveCommonTestTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 139
{
"content": "wordLists:\n userIds:\n - \"1\"\n - \"2\"\n - \"100\"\n sensitiveEndpoints:\n - /api/admin\n - /api/internal"
}{}YAML content of the test template to run
id: BOLA_TEST_CUSTOM info: name: Custom BOLA Test severity: HIGH ...Optional hex ID of an existing testing run to use for context
6a4c1b3dde8f92780c91637fTest executed; results returned
6a4c1b3dde8f92780c91637fUse with fetchTestingRunPlaygroundStatus to poll for async results
7b5d2e4ffe9a38791da2748aIssue record created if test found a vulnerability
Map of test ID to subcategory info object
Callback UUIDs for out-of-band detection tests
["cb-uuid-abc123"]Forbidden
Unprocessable — invalid YAML template
POST /api/runTestForGivenTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 350
{
"content": "id: BOLA_TEST_CUSTOM\ninfo:\n name: Custom BOLA Test\n severity: HIGH\n...",
"apiInfoKey": {
"apiCollectionId": 1748293710,
"url": "https://api.example.com/v1/users/22",
"method": "GET"
},
"testingRunHexId": "6a4c1b3dde8f92780c91637f",
"testingRunConfig": {
"overriddenTestAppUrl": "https://staging-api.example.com",
"testRoleId": "ATTACKER_TOKEN_ALL"
}
}{
"testingRunHexId": "6a4c1b3dde8f92780c91637f",
"testingRunPlaygroundHexId": "7b5d2e4ffe9a38791da2748a",
"testingRunResult": {
"vulnerable": true,
"testResults": [
{}
]
},
"testingRunIssues": {},
"subCategoryMap": {},
"callbackUuids": [
"cb-uuid-abc123"
]
}Name of the test role to update
ATTACKER_TOKEN_ALLAkto user roles allowed to use this test role
["ADMIN","MEMBER"]Test role meta saved
Forbidden
Unprocessable — test role not found or scope roles empty
POST /api/saveTestRoleMeta HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"roleName": "ATTACKER_TOKEN_ALL",
"scopeRoles": [
"ADMIN",
"MEMBER"
]
}{}ATTACKER_TOKEN_ALLTest role deleted
Forbidden
Unprocessable — role not found
POST /api/deleteTestRole HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"roleName": "ATTACKER_TOKEN_ALL"
}{}ATTACKER_TOKEN_ALL0-based index of the auth entry to remove from authWithCondList
0Auth entry deleted; returns updated test role
Updated TestRoles object after deletion
Forbidden
Unprocessable — role not found
POST /api/deleteAuthFromRole HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"roleName": "ATTACKER_TOKEN_ALL",
"index": 0
}{
"selectedRole": {}
}ATTACKER_TOKEN_ALL0-based index of the auth entry to update
0Optional regex to restrict which URLs this auth applies to
.*Auth entry updated; returns updated test role
Forbidden
Unprocessable — role not found or invalid URL regex
POST /api/updateAuthInRole HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 170
{
"roleName": "ATTACKER_TOKEN_ALL",
"index": 0,
"authParamData": [
{
"key": "Authorization",
"value": "Bearer [REDACTED_TOKEN]",
"where": "HEADER",
"showHeader": true
}
],
"urlRegex": ".*"
}{
"selectedRole": {}
}ATTACKER_TOKEN_ALLOptional regex to restrict which URLs this auth applies to
.*Auth entry added; returns updated test role
Forbidden
Unprocessable — role not found or invalid URL regex
POST /api/addAuthToRole HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 160
{
"roleName": "ATTACKER_TOKEN_ALL",
"authParamData": [
{
"key": "Authorization",
"value": "Bearer [REDACTED_TOKEN]",
"where": "HEADER",
"showHeader": true
}
],
"urlRegex": ".*"
}{
"selectedRole": {
"name": "ATTACKER_TOKEN_ALL",
"authWithCondList": [
{}
]
}
}Auth mechanism type. Must not be HARDCODED, SAMPLE_DATA, or TLS_AUTH.
LOGIN_FLOWPossible values: Optional node ID for multi-step login flow
step-1Login flow step executed successfully
Forbidden
Unprocessable — invalid type (HARDCODED/SAMPLE_DATA/TLS_AUTH) or login flow execution failed
POST /api/triggerSingleLoginFlow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 234
{
"type": "LOGIN_FLOW",
"requestData": [
{
"url": "https://api.example.com/v1/login",
"method": "POST",
"body": "{\"username\":\"admin@example.com\",\"password\":\"[REDACTED]\"}",
"headers": {
"Content-Type": "application/json"
}
}
],
"nodeId": "step-1"
}{
"responses": [
{
"statusCode": 200,
"body": "{\"token\":\"[REDACTED_TOKEN]\"}",
"headers": {}
}
]
}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex ObjectId of the AccessMatrixTaskInfo document to update
64a1f2e3b5c7d8e9f0a1b2c3Role name; stored as roleName + '_GROUP' in endpointLogicalGroupName
ADMINScan frequency. Values ≤ 0 default to 86400.
43200Task updated successfully
Invalid hexId or other error
POST /api/updateAccessMatrixTask HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"hexId": "64a1f2e3b5c7d8e9f0a1b2c3",
"roleName": "ADMIN",
"frequencyInSeconds": 43200
}{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsREAD_ONLYAccess matrix task created or updated successfully
POST /api/createMultipleAccessMatrixTasks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"roleName": "READ_ONLY"
}Access matrix task created or updated successfully
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsRole whose access matrix data should be deleted
READ_ONLYAccess matrix data for the role deleted successfully
POST /api/deleteAccessMatrix HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"roleName": "READ_ONLY"
}Access matrix data for the role deleted successfully
{}application/jsonYOUR_API_KEY from Settings > Integrations > Akto APIsHex ObjectId of the AccessMatrixTaskInfo document to delete
64a1f2e3b5c7d8e9f0a1b2c3Task deleted successfully
Unable to delete — invalid hexId
POST /api/deleteAccessMatrixTask HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"hexId": "64a1f2e3b5c7d8e9f0a1b2c3"
}{}Last updated