Modify Data
Table of Contents
System & Health
879c9527-b664-403e-9b7e-1abe0ac05ab6Health check sent successfully
No content
POST /api/sendHealthCheck HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53
{
"instanceId": "879c9527-b664-403e-9b7e-1abe0ac05ab6"
}Health check sent successfully
No content
TRAFFIC_COLLECTORModule info deleted successfully
No content
POST /api/deleteModuleInfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"moduleId": "TRAFFIC_COLLECTOR"
}Module info deleted successfully
No content
TRAFFIC_COLLECTORModules reboot initiated successfully
No content
POST /api/rebootModules HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"moduleIds": [
"TRAFFIC_COLLECTOR"
]
}Modules reboot initiated successfully
No content
TRAFFIC_COLLECTOR{"DEBUG_MODE":"true","LOG_LEVEL":"INFO"}Module environment updated and reboot initiated
No content
POST /api/updateModuleEnvAndReboot HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"moduleId": "TRAFFIC_COLLECTOR",
"envVariables": {
"DEBUG_MODE": "true",
"LOG_LEVEL": "INFO"
}
}Module environment updated and reboot initiated
No content
1.97.0falseUpdate applied successfully
No content
POST /api/takeUpdate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"version": "1.97.0",
"force": false
}Update applied successfully
No content
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
Settings & Toggles
SETTING_NAMEnew_valueSettings updated successfully
No content
POST /api/modifyAccountSettings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"settingKey": "SETTING_NAME",
"settingValue": "new_value"
}Settings updated successfully
No content
DARKUI mode updated successfully
No content
POST /api/updateAktoUIMode HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"uiMode": "DARK"
}UI mode updated successfully
No content
trueRedaction feature toggled successfully
No content
POST /api/toggleRedactFeature HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}Redaction feature toggled successfully
No content
trueCase sensitivity setting updated
No content
POST /api/toggleCaseSensitiveApis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"caseSensitive": true
}Case sensitivity setting updated
No content
trueTesting module switched successfully
No content
POST /api/switchTestingModule HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}Testing module switched successfully
No content
trueVersion merging setting updated
No content
POST /api/enableMergingOnVersionsInApis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}Version merging setting updated
No content
trueAsync merge setting updated
No content
POST /api/updateMergeAsyncOutside HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}Async merge setting updated
No content
1000Rate limit updated successfully
No content
POST /api/updateGlobalRateLimit HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"globalRateLimit": 1000
}Rate limit updated successfully
No content
trueSummary time setting updated
No content
POST /api/updateIgnoreTimeForSummaries HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"ignoreTime": true
}Summary time setting updated
No content
192.0.2.0/24Private CIDR IPs updated
No content
POST /api/updatePrivateCidrIps HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"privateCidrList": [
"192.0.2.0/24"
]
}Private CIDR IPs updated
No content
.*\.example\.com.*Proxy pattern added successfully
No content
POST /api/addMatchingPatternForProxy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"pattern": ".*\\.example\\.com.*"
}Proxy pattern added successfully
No content
192.0.2.100Partner IPs updated
No content
POST /api/updatePartnerIps HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"partnerIpList": [
"192.0.2.100"
]
}Partner IPs updated
No content
trueNew merging setting toggled
No content
POST /api/toggleNewMergingEnabled HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"newMergingEnabled": true
}New merging setting toggled
No content
trueBody matching setting toggled
No content
POST /api/toggleDoBodyMatch HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"doBodyMatch": true
}Body matching setting toggled
No content
falseTelemetry setting toggled
No content
POST /api/toggleTelemetry HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"enableTelemetry": false
}Telemetry setting toggled
No content
trueURL settings updated
No content
POST /api/updateUrlSettings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"urlRegexMatchingEnabled": true
}URL settings updated
No content
trueDebug logs feature toggled
No content
POST /api/toggleDebugLogsFeature HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}Debug logs feature toggled
No content
SAASSetup type updated
No content
POST /api/updateSetupType HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"setupType": "SAAS"
}Setup type updated
No content
300Traffic alert threshold updated
No content
POST /api/updateTrafficAlertThresholdSeconds HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"thresholdSeconds": 300
}Traffic alert threshold updated
No content
trueArchival feature toggled
No content
POST /api/toggleArchivalEnabled HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"enabled": true
}Archival feature toggled
No content
trueRetrospective filter settings updated
No content
POST /api/updateRetrospectiveFilterSettings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"allowRetrospectiveMerging": true
}Retrospective filter settings updated
No content
Compulsory description settings updated
No content
POST /api/updateCompulsoryDescription HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"compulsoryDescription": {}
}Compulsory description settings updated
No content
falseBlock logs setting updated
No content
POST /api/updateBlockLogs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"blockLogs": false
}Block logs setting updated
No content
Filter log policy updated
No content
POST /api/updateFilterLogPolicy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"filterLogPolicy": []
}Filter log policy updated
No content
SSO & Authentication
Google OAuth configuration retrieved successfully
Google OAuth client ID registered for this Akto instance
812345678901-abcdef1234567890abcdef1234567890.apps.googleusercontent.comUnauthorized — no Google OAuth configuration found for this account
Forbidden — caller lacks INTEGRATIONS / READ_WRITE permission
POST /api/googleConfig HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"client_id": "812345678901-abcdef1234567890abcdef1234567890.apps.googleusercontent.com"
}GitHub OAuth App client ID
Iv1.a1b2c3d4e5f6g7h8GitHub OAuth App client secret
[REDACTED_GITHUB_CLIENT_SECRET]Base URL for GitHub Enterprise instances (leave empty for github.com)
https://github.example-corp.comGitHub API base URL for Enterprise instances (leave empty for github.com)
https://github.example-corp.com/api/v3GitHub SSO integration added successfully
Forbidden — caller lacks ADMIN_ACTIONS / READ_WRITE permission
Unprocessable — another SSO integration already exists, or deployment is not on-prem
POST /api/addGithubSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 198
{
"githubClientId": "Iv1.a1b2c3d4e5f6g7h8",
"githubClientSecret": "[REDACTED_GITHUB_CLIENT_SECRET]",
"githubUrl": "https://github.example-corp.com",
"githubApiUrl": "https://github.example-corp.com/api/v3"
}{}GitHub SSO integration deleted successfully
Forbidden — caller lacks ADMIN_ACTIONS permission
Unprocessable — deployment is not on-prem
POST /api/deleteGithubSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{}GitHub App ID (numeric identifier shown on the App settings page)
987654RSA private key PEM content (with or without header/footer lines; newlines are stripped automatically)
[REDACTED_RSA_PRIVATE_KEY_PEM]GitHub App credentials validated and saved successfully
Forbidden — caller lacks ADMIN_ACTIONS / READ_WRITE permission
Unprocessable — invalid credentials or not on-prem
POST /api/addGithubAppSecretKey HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"githubAppId": "987654",
"githubAppSecretKey": "[REDACTED_RSA_PRIVATE_KEY_PEM]"
}{}GitHub App credentials deleted successfully
Deleted github app ID and secret keyForbidden — caller lacks ADMIN_ACTIONS / READ_WRITE permission
Unprocessable — deployment is not on-prem
POST /api/deleteGithubAppSecretKey HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"actionMessages": [
"Deleted github app ID and secret key"
]
}Okta OIDC application client ID
0oa1b2c3d4e5F6G7H890Okta OIDC application client secret
[REDACTED_OKTA_CLIENT_SECRET]Okta Authorization Server ID (use 'default' for the org-level server)
aus1b2c3d4e5F6G7H890Okta organization domain URL
https://example-corp.okta.comRedirect URI registered in the Okta application
https://app.akto.example-corp.com/login/oauth2/code/oktaOkta Management API token — required for fetchOktaGroups and role mapping. Stored server-side; returned masked as '*' on subsequent reads.
[REDACTED_OKTA_MANAGEMENT_API_TOKEN]Okta SSO integration added successfully
Returns '*' if a management API token was saved, null otherwise
*Forbidden — caller lacks ADMIN_ACTIONS / READ_WRITE permission
Unprocessable — another SSO integration already exists
POST /api/addOktaSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 307
{
"clientId": "0oa1b2c3d4e5F6G7H890",
"clientSecret": "[REDACTED_OKTA_CLIENT_SECRET]",
"authorisationServerId": "aus1b2c3d4e5F6G7H890",
"oktaDomain": "https://example-corp.okta.com",
"redirectUri": "https://app.akto.example-corp.com/login/oauth2/code/okta",
"managementApiToken": "[REDACTED_OKTA_MANAGEMENT_API_TOKEN]"
}{
"managementApiToken": "*"
}Okta SSO integration deleted successfully
Forbidden — caller lacks ADMIN_ACTIONS permission
POST /api/deleteOktaSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{}Optional — update the stored Okta Management API token. Pass empty string to remove it. Pass '' or a value containing '**' to leave the existing token unchanged.
[REDACTED_OKTA_MANAGEMENT_API_TOKEN]Group role mapping saved successfully
Returns '*' if a management API token is now stored, null otherwise
*Forbidden — caller lacks ADMIN_ACTIONS permission
Unprocessable — invalid role value or duplicate role assignment
POST /api/saveOktaGroupRoleMapping HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 165
{
"oktaGroupToAktoUserRoleMap": {
"Security-Admins": "ADMIN",
"Dev-Engineers": "DEVELOPER",
"Auditors": "GUEST"
},
"managementApiToken": "[REDACTED_OKTA_MANAGEMENT_API_TOKEN]"
}{
"managementApiToken": "*"
}SAML provider type. Use AZURE for Azure AD / Microsoft Entra ID, or GOOGLE_SAML for Google Workspace SAML.
AZUREPossible values: Base64-encoded X.509 public certificate from the identity provider's SAML metadata
[REDACTED_X509_CERTIFICATE_BASE64]SAML Entity ID / Issuer URI of the identity provider
https://sts.windows.net/a1b2c3d4-e5f6-7890-abcd-ef1234567890/SAML SSO login URL provided by the identity provider
https://login.microsoftonline.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890/saml2Assertion Consumer Service URL — the Akto callback endpoint that receives the SAML response
https://app.akto.example-corp.com/api/saml/callbackApplication / Audience URI registered in the identity provider for this Akto instance
https://app.akto.example-corp.comSAML SSO integration added successfully
Forbidden — caller lacks ADMIN_ACTIONS permission
Unprocessable — another SSO integration already exists
POST /api/addSAMLSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 368
{
"configType": "AZURE",
"x509Certificate": "[REDACTED_X509_CERTIFICATE_BASE64]",
"ssoEntityId": "https://sts.windows.net/a1b2c3d4-e5f6-7890-abcd-ef1234567890/",
"loginUrl": "https://login.microsoftonline.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890/saml2",
"acsUrl": "https://app.akto.example-corp.com/api/saml/callback",
"applicationIdentifier": "https://app.akto.example-corp.com"
}{}SAML provider type to delete
AZUREPossible values: SAML SSO integration deleted successfully
Forbidden — caller lacks ADMIN_ACTIONS permission
POST /api/deleteSamlSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"configType": "AZURE"
}{}Runtime & Infrastructure
stack-abc123Stack creation progress retrieved
No content
GET /api/checkStackCreationProgress HTTP/1.1
Accept: */*
Stack creation progress retrieved
No content
akto-prod-stackAWSus-east-1Stack creation initiated
No content
POST /api/createRuntimeStack HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"stackName": "akto-prod-stack",
"cloudProvider": "AWS",
"region": "us-east-1"
}Stack creation initiated
No content
[REDACTED-AWS-ACCOUNT]AWS account IDs added successfully
No content
POST /api/addAwsAccountIdsForApiGatewayLogging HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"accountIds": [
"[REDACTED-AWS-ACCOUNT]"
]
}AWS account IDs added successfully
No content
Logs, Audit & Traffic
ARCHIVEDAudit data updated
No content
POST /api/updateAuditData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"auditId": "text",
"status": "ARCHIVED"
}Audit data updated
No content
Dashboard, Filters & Misc
Dashboard layout saved successfully
No content
POST /api/saveDashboardLayout HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Dashboard layout saved successfully
No content
Filter template saved successfully
No content
POST /api/saveFilterYamlTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Filter template saved successfully
No content
Browser extension config saved
No content
POST /api/saveBrowserExtensionConfig HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Browser extension config saved
No content
Browser extension config deleted
No content
POST /api/deleteBrowserExtensionConfigs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Browser extension config deleted
No content
Maintenance
OPTIONS and slash APIs deleted
No content
POST /api/deleteOptionAndSlashApis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}OPTIONS and slash APIs deleted
No content
Last updated