Fetch Data
Table of Contents
System & Health
2
GET /api/allMetricsDescription
Retrieves descriptions and metadata for all available system metrics.
3
GET /api/health
Checks the health status of the system and services.
4
GET /api/fetchModuleInfo
Fetches information about system modules and their status.
17663980001766398064RT_KAFKA_879c9527-b664-403e-9b7e-1abe0ac05ab6Metrics retrieved successfully
POST /api/metrics HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 126
{
"startTime": 1766398000,
"endTime": 1766398064,
"metricIdPrefix": "RT_KAFKA_",
"instanceId": "879c9527-b664-403e-9b7e-1abe0ac05ab6"
}Metrics retrieved successfully
{
"metrics": [
{
"metricId": "RT_KAFKA_RECORD_COUNT",
"value": 0,
"timestamp": 1766398064,
"instanceId": "879c9527-b664-403e-9b7e-1abe0ac05ab6"
}
]
}Metrics descriptions retrieved
RT_KAFKA_RECORD_COUNTGET /api/allMetricsDescription HTTP/1.1
Accept: */*
Metrics descriptions retrieved
{
"names": [
"RT_KAFKA_RECORD_COUNT"
]
}Settings & Toggles
1
GET /api/fetchAdminSettings
Fetches admin-level settings for the current account or organization.
2
GET /api/getAccountSettingsForAdvancedFilters
Retrieves account settings specific to advanced filter configurations.
Admin settings retrieved successfully
[REDACTED-VERSION] - [REDACTED-TIMESTAMP] - [REDACTED-VERSION]truefalseGET /api/fetchAdminSettings HTTP/1.1
Accept: */*
Admin settings retrieved successfully
{
"dashboardVersion": "[REDACTED-VERSION] - [REDACTED-TIMESTAMP] - [REDACTED-VERSION]",
"urlRegexMatchingEnabled": true,
"telemetrySettings": {
"customerEnabled": false,
"telemetryEnabled": false
},
"showOnboarding": false
}SSO & Authentication
1
POST /api/fetchGithubSso
Fetches the current GitHub SSO configuration for the organization.
2
POST /api/fetchGithubAppId
Retrieves the GitHub App ID configured for SSO integration.
3
POST /api/fetchOktaSso
Fetches the current Okta SSO configuration and settings.
4
POST /api/fetchOktaGroups
Retrieves available Okta groups for role mapping configuration.
5
POST /api/fetchSAMLSso
Fetches the current SAML SSO configuration and metadata.
GitHub SSO configuration retrieved successfully
GitHub OAuth App client ID currently configured
Iv1.a1b2c3d4e5f6g7h8GitHub Enterprise base URL, null for github.com
https://github.example-corp.comGitHub Enterprise API URL, null for github.com
https://github.example-corp.com/api/v3Forbidden — caller lacks ADMIN_ACTIONS / READ permission
Unprocessable — a different SSO type is already active
POST /api/fetchGithubSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"githubClientId": "Iv1.a1b2c3d4e5f6g7h8",
"githubUrl": "https://github.example-corp.com",
"githubApiUrl": "https://github.example-corp.com/api/v3"
}GitHub App ID retrieved successfully
GitHub App numeric or string identifier
987654Forbidden — caller lacks ADMIN_ACTIONS / READ permission
POST /api/fetchGithubAppId HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"githubAppId": "987654"
}Okta SSO configuration retrieved successfully
Okta OIDC application client ID
0oa1b2c3d4e5F6G7H890Okta organization domain URL
https://example-corp.okta.comOkta Authorization Server ID
aus1b2c3d4e5F6G7H890Configured redirect URI
https://app.akto.example-corp.com/login/oauth2/code/oktaReturns '*' if a management API token is stored, null otherwise
*Forbidden — caller lacks ADMIN_ACTIONS permission
Unprocessable — a different SSO type is already active
POST /api/fetchOktaSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"clientId": "0oa1b2c3d4e5F6G7H890",
"oktaDomain": "https://example-corp.okta.com",
"authorisationServerId": "aus1b2c3d4e5F6G7H890",
"redirectUri": "https://app.akto.example-corp.com/login/oauth2/code/okta",
"oktaGroupToAktoUserRoleMap": {
"Security-Admins": "ADMIN",
"Dev-Engineers": "DEVELOPER",
"Auditors": "GUEST"
},
"managementApiToken": "*"
}Okta group names retrieved successfully
List of all group names in the Okta organization
["Security-Admins","Dev-Engineers","QA-Team","Auditors","Everyone"]Forbidden — caller lacks ADMIN_ACTIONS permission
Unprocessable — Okta SSO not configured, or management API token missing
POST /api/fetchOktaGroups HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}{
"oktaGroupNames": [
"Security-Admins",
"Dev-Engineers",
"QA-Team",
"Auditors",
"Everyone"
]
}SAML provider type to fetch
AZUREPossible values: SAML SSO configuration retrieved successfully
Identity provider SAML SSO login URL
https://login.microsoftonline.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890/saml2Identity provider SAML Entity ID / Issuer URI
https://sts.windows.net/a1b2c3d4-e5f6-7890-abcd-ef1234567890/Forbidden — caller lacks ADMIN_ACTIONS / READ permission
Unprocessable — a different SSO type is already active
POST /api/fetchSAMLSso HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"configType": "AZURE"
}{
"loginUrl": "https://login.microsoftonline.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890/saml2",
"ssoEntityId": "https://sts.windows.net/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
}Runtime & Infrastructure
1
GET /api/fetchRuntimeInstances
Fetches information about all configured runtime instances and their status.
2
POST /api/fetchRuntimeMetrics
Retrieves metrics and performance data for runtime instances.
3
GET /api/fetchRuntimeHelmCommand
Fetches the Helm command required for deploying the runtime.
4
GET /api/fetchAwsAccountIdsForApiGatewayLogging
Retrieves AWS account IDs configured for API Gateway logging.
5
GET /api/fetchLoadBalancers
Fetches all configured load balancers and their settings.
RUNNINGRuntime instances retrieved successfully
No content
GET /api/fetchRuntimeInstances HTTP/1.1
Accept: */*
Runtime instances retrieved successfully
No content
879c9527-b664-403e-9b7e-1abe0ac05ab6CPURuntime metrics retrieved
No content
POST /api/fetchRuntimeMetrics HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 72
{
"instanceId": "879c9527-b664-403e-9b7e-1abe0ac05ab6",
"metricType": "CPU"
}Runtime metrics retrieved
No content
Logs, Audit & Traffic
1
POST /api/fetchLogs
Fetches system logs from the current session or a specified timeframe.
2
POST /api/fetchLogsFromDb
Retrieves logs stored in the database with filtering and pagination options.
3
POST /api/fetchTestingLogs
Fetches logs specific to security testing operations.
4
POST /api/fetchApiAuditLogsFromDb
Retrieves audit logs for API operations from the database.
5
POST /api/fetchAuditData
Fetches audit trail data and user activity logs.
6
POST /api/fetchTrafficMetrics
Retrieves traffic metrics and analytics data.
7
POST /api/fetchTrafficMetricsDesciptions
Fetches descriptions and metadata for traffic metrics.
8
POST /api/fetchHistoricalData
Retrieves historical data for analysis and reporting.
9
POST /api/fetchApiStats
Fetches statistics and performance metrics for APIs.
17673529001767352972ERROR100Logs retrieved successfully
1500POST /api/fetchLogs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 76
{
"startTime": 1767352900,
"endTime": 1767352972,
"logLevel": "ERROR",
"limit": 100
}Logs retrieved successfully
{
"logs": [
{
"key": "info",
"log": "class com.akto.testing.ApiExecutor: [Default_2064] acc: [REDACTED-ACCOUNT], Final url is: http://localhost:9000/api/bulkWriteTrafficMetrics",
"timestamp": 1766730670
}
],
"total": 1500
}050Database logs retrieved
No content
POST /api/fetchLogsFromDb HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"skip": 0,
"limit": 50
}Database logs retrieved
No content
test-abc123Testing logs retrieved
No content
POST /api/fetchTestingLogs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 24
{
"testId": "test-abc123"
}Testing logs retrieved
No content
020api/switchTestingModuleAPI audit logs retrieved
85POST /api/fetchApiAuditLogsFromDb HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"skip": 0,
"limit": 20,
"apiEndpoint": "api/switchTestingModule"
}API audit logs retrieved
{
"auditLogs": [
{
"_id": "6932edc79a05fc641a050ade",
"actionDescription": "Error: Description not available",
"apiEndpoint": "api/switchTestingModule",
"timestamp": 1764945351,
"userEmail": "[REDACTED-EMAIL]",
"userIpAddress": "192.0.2.100"
}
],
"total": 85
}2044120442api.example.comTraffic metrics retrieved
No content
POST /api/fetchTrafficMetrics HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"startTime": 20441,
"endTime": 20442,
"host": "api.example.com"
}Traffic metrics retrieved
No content
TRAFFICHistorical data retrieved
No content
POST /api/fetchHistoricalData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"dataType": "TRAFFIC"
}Historical data retrieved
No content
Dashboard, Filters & Misc
1
GET /api/fetchDashboardLayout
Retrieves the user's saved dashboard layout configuration.
2
GET /api/getRecentActivities
Fetches recent user activities and system events.
3
GET /api/fetchFilterYamlTemplate
Retrieves YAML filter templates for custom filters.
4
GET /api/fetchMetadataFilters
Fetches available metadata filter options and configurations.
5
GET /api/fetchBrowserExtensionConfigs
Retrieves browser extension configurations for the current user.
6
POST /api/getSummaryInfoForChanges
Fetches summary information for changes and modifications.
advanced-filterFilter YAML template retrieved
No content
GET /api/fetchFilterYamlTemplate HTTP/1.1
Accept: */*
Filter YAML template retrieved
No content
Change summary retrieved
No content
POST /api/getSummaryInfoForChanges HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2
{}Change summary retrieved
No content
Service Graph, Tracing & Misc
1
POST /api/fetchApiDependencies
Fetches API dependency information and service relationships.
2
GET /api/checkIfDependencyGraphAvailable
Checks if the dependency graph is available for the current configuration.
3
POST /api/fetchLatestTraces
Retrieves the latest traces from the tracing system.
4
GET /api/fetchSpansForTrace
Fetches individual spans associated with a specific trace.
5
POST /api/findSvcToSvcGraphEdges
Retrieves service-to-service graph edges for visualization.
6
POST /api/findSvcToSvcGraphNodes
Fetches service-to-service graph nodes representing services.
7
POST /api/fetchMiniTestingServiceNames
Retrieves available service names for mini testing.
Maintenance
1
GET /api/fetchParamsStatus
Fetches the status of parameters and configurations for maintenance purposes.
Last updated