Fetch Data

Table of Contents

System & Health

#
API
Description

1

Fetches system metrics and performance data.

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.

POST request for endpoint /api/metrics

post
Body
startTimeintegerOptionalExample: 1766398000
endTimeintegerOptionalExample: 1766398064
metricIdPrefixstringOptionalExample: RT_KAFKA_
instanceIdstringOptionalExample: 879c9527-b664-403e-9b7e-1abe0ac05ab6
Responses
chevron-right
200

Metrics retrieved successfully

application/json
post
/api/metrics
200

Metrics retrieved successfully

GET request for endpoint /api/allMetricsDescription

get
Responses
chevron-right
200

Metrics descriptions retrieved

application/json
namesstring[]OptionalExample: RT_KAFKA_RECORD_COUNT
get
/api/allMetricsDescription
200

Metrics descriptions retrieved

GET request for endpoint /api/health

get
Responses
chevron-right
200

System is healthy

application/json
statusstringOptionalExample: UP
timestampintegerOptionalExample: 1767352972
get
/api/health
200

System is healthy

Settings & Toggles

#
API
Description

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.

GET request for endpoint /api/fetchAdminSettings

get
Responses
chevron-right
200

Admin settings retrieved successfully

application/json
dashboardVersionstringOptionalExample: [REDACTED-VERSION] - [REDACTED-TIMESTAMP] - [REDACTED-VERSION]
urlRegexMatchingEnabledbooleanOptionalExample: true
showOnboardingbooleanOptionalExample: false
get
/api/fetchAdminSettings
200

Admin settings retrieved successfully

GET request for endpoint /api/getAccountSettingsForAdvancedFilters

get
Responses
chevron-right
200

Advanced filter settings retrieved

No content

get
/api/getAccountSettingsForAdvancedFilters
200

Advanced filter settings retrieved

No content

SSO & Authentication

#
API
Description

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.

POST request for endpoint /api/fetchGithubSso

post
Body
objectOptional
Responses
chevron-right
200

GitHub SSO configuration retrieved successfully

application/json
githubClientIdstringOptional

GitHub OAuth App client ID currently configured

Example: Iv1.a1b2c3d4e5f6g7h8
githubUrlstringOptional

GitHub Enterprise base URL, null for github.com

Example: https://github.example-corp.com
githubApiUrlstringOptional

GitHub Enterprise API URL, null for github.com

Example: https://github.example-corp.com/api/v3
post
/api/fetchGithubSso

POST request for endpoint /api/fetchGithubAppId

post
Body
objectOptional
Responses
chevron-right
200

GitHub App ID retrieved successfully

application/json
githubAppIdstringOptional

GitHub App numeric or string identifier

Example: 987654
post
/api/fetchGithubAppId

POST request for endpoint /api/fetchOktaSso

post
Body
objectOptional
Responses
chevron-right
200

Okta SSO configuration retrieved successfully

application/json
clientIdstringOptional

Okta OIDC application client ID

Example: 0oa1b2c3d4e5F6G7H890
oktaDomainstringOptional

Okta organization domain URL

Example: https://example-corp.okta.com
authorisationServerIdstringOptional

Okta Authorization Server ID

Example: aus1b2c3d4e5F6G7H890
redirectUristringOptional

Configured redirect URI

Example: https://app.akto.example-corp.com/login/oauth2/code/okta
managementApiTokenstringOptional

Returns '*' if a management API token is stored, null otherwise

Example: *
post
/api/fetchOktaSso

POST request for endpoint /api/fetchOktaGroups

post
Body
objectOptional
Responses
chevron-right
200

Okta group names retrieved successfully

application/json
oktaGroupNamesstring[]Optional

List of all group names in the Okta organization

Example: ["Security-Admins","Dev-Engineers","QA-Team","Auditors","Everyone"]
post
/api/fetchOktaGroups

POST request for endpoint /api/fetchSAMLSso

post
Body
configTypestring · enumRequired

SAML provider type to fetch

Example: AZUREPossible values:
Responses
chevron-right
200

SAML SSO configuration retrieved successfully

application/json
loginUrlstringOptional

Identity provider SAML SSO login URL

Example: https://login.microsoftonline.com/a1b2c3d4-e5f6-7890-abcd-ef1234567890/saml2
ssoEntityIdstringOptional

Identity provider SAML Entity ID / Issuer URI

Example: https://sts.windows.net/a1b2c3d4-e5f6-7890-abcd-ef1234567890/
post
/api/fetchSAMLSso

Runtime & Infrastructure

#
API
Description

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.

GET request for endpoint /api/fetchRuntimeInstances

get
Query parameters
statusstringOptionalExample: RUNNING
Responses
chevron-right
200

Runtime instances retrieved successfully

No content

get
/api/fetchRuntimeInstances
200

Runtime instances retrieved successfully

No content

POST request for endpoint /api/fetchRuntimeMetrics

post
Body
instanceIdstringOptionalExample: 879c9527-b664-403e-9b7e-1abe0ac05ab6
metricTypestringOptionalExample: CPU
Responses
chevron-right
200

Runtime metrics retrieved

No content

post
/api/fetchRuntimeMetrics
200

Runtime metrics retrieved

No content

GET request for endpoint /api/fetchRuntimeHelmCommand

get
Responses
chevron-right
200

Helm command retrieved

No content

get
/api/fetchRuntimeHelmCommand
200

Helm command retrieved

No content

GET request for endpoint /api/fetchAwsAccountIdsForApiGatewayLogging

get
Responses
chevron-right
200

AWS account IDs retrieved

No content

get
/api/fetchAwsAccountIdsForApiGatewayLogging
200

AWS account IDs retrieved

No content

GET request for endpoint /api/fetchLoadBalancers

get
Query parameters
providerstringOptionalExample: AWS
Responses
chevron-right
200

Load balancers retrieved

No content

get
/api/fetchLoadBalancers
200

Load balancers retrieved

No content

Logs, Audit & Traffic

#
API
Description

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.

POST request for endpoint /api/fetchLogs

post
Body
startTimeintegerOptionalExample: 1767352900
endTimeintegerOptionalExample: 1767352972
logLevelstringOptionalExample: ERROR
limitintegerOptionalExample: 100
Responses
chevron-right
200

Logs retrieved successfully

application/json
totalintegerOptionalExample: 1500
post
/api/fetchLogs
200

Logs retrieved successfully

POST request for endpoint /api/fetchLogsFromDb

post
Body
skipintegerOptionalExample: 0
limitintegerOptionalExample: 50
Responses
chevron-right
200

Database logs retrieved

No content

post
/api/fetchLogsFromDb
200

Database logs retrieved

No content

POST request for endpoint /api/fetchTestingLogs

post
Body
testIdstringOptionalExample: test-abc123
Responses
chevron-right
200

Testing logs retrieved

No content

post
/api/fetchTestingLogs
200

Testing logs retrieved

No content

POST request for endpoint /api/fetchApiAuditLogsFromDb

post
Body
skipintegerOptionalExample: 0
limitintegerOptionalExample: 20
apiEndpointstringOptionalExample: api/switchTestingModule
Responses
chevron-right
200

API audit logs retrieved

application/json
totalintegerOptionalExample: 85
post
/api/fetchApiAuditLogsFromDb
200

API audit logs retrieved

POST request for endpoint /api/fetchAuditData

post
Body
objectOptional
Responses
chevron-right
200

Audit data retrieved

No content

post
/api/fetchAuditData
200

Audit data retrieved

No content

POST request for endpoint /api/fetchTrafficMetrics

post
Body
startTimeintegerOptionalExample: 20441
endTimeintegerOptionalExample: 20442
hoststringOptionalExample: api.example.com
Responses
chevron-right
200

Traffic metrics retrieved

No content

post
/api/fetchTrafficMetrics
200

Traffic metrics retrieved

No content

POST request for endpoint /api/fetchHistoricalData

post
Body
dataTypestringOptionalExample: TRAFFIC
Responses
chevron-right
200

Historical data retrieved

No content

post
/api/fetchHistoricalData
200

Historical data retrieved

No content

POST request for endpoint /api/fetchApiStats

post
Body
objectOptional
Responses
chevron-right
200

API statistics retrieved

No content

post
/api/fetchApiStats
200

API statistics retrieved

No content

Dashboard, Filters & Misc

#
API
Description

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.

GET request for endpoint /api/fetchDashboardLayout

get
Query parameters
layoutNamestringOptionalExample: default
Responses
chevron-right
200

Dashboard layout retrieved

No content

get
/api/fetchDashboardLayout
200

Dashboard layout retrieved

No content

GET request for endpoint /api/getRecentActivities

get
Query parameters
limitintegerOptionalExample: 20
Responses
chevron-right
200

Recent activities retrieved

No content

get
/api/getRecentActivities
200

Recent activities retrieved

No content

GET request for endpoint /api/fetchFilterYamlTemplate

get
Query parameters
templateNamestringOptionalExample: advanced-filter
Responses
chevron-right
200

Filter YAML template retrieved

No content

get
/api/fetchFilterYamlTemplate
200

Filter YAML template retrieved

No content

GET request for endpoint /api/fetchMetadataFilters

get
Responses
chevron-right
200

Metadata filters retrieved

No content

get
/api/fetchMetadataFilters
200

Metadata filters retrieved

No content

GET request for endpoint /api/fetchBrowserExtensionConfigs

get
Responses
chevron-right
200

Browser extension configs retrieved

No content

get
/api/fetchBrowserExtensionConfigs
200

Browser extension configs retrieved

No content

POST request for endpoint /api/getSummaryInfoForChanges

post
Body
objectOptional
Responses
chevron-right
200

Change summary retrieved

No content

post
/api/getSummaryInfoForChanges
200

Change summary retrieved

No content

Service Graph, Tracing & Misc

#
API
Description

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.

POST request for endpoint /api/fetchApiDependencies

post
Body
objectOptional
Responses
chevron-right
200

API dependencies retrieved

No content

post
/api/fetchApiDependencies
200

API dependencies retrieved

No content

GET request for endpoint /api/checkIfDependencyGraphAvailable

get
Responses
chevron-right
200

Dependency graph availability checked

No content

get
/api/checkIfDependencyGraphAvailable
200

Dependency graph availability checked

No content

POST request for endpoint /api/fetchLatestTraces

post
Body
objectOptional
Responses
chevron-right
200

Latest traces retrieved

No content

post
/api/fetchLatestTraces
200

Latest traces retrieved

No content

GET request for endpoint /api/fetchSpansForTrace

get
Query parameters
traceIdstringOptionalExample: trace-abc123
Responses
chevron-right
200

Trace spans retrieved

No content

get
/api/fetchSpansForTrace
200

Trace spans retrieved

No content

POST request for endpoint /api/findSvcToSvcGraphEdges

post
Body
objectOptional
Responses
chevron-right
200

Graph edges retrieved

No content

post
/api/findSvcToSvcGraphEdges
200

Graph edges retrieved

No content

POST request for endpoint /api/findSvcToSvcGraphNodes

post
Body
objectOptional
Responses
chevron-right
200

Graph nodes retrieved

No content

post
/api/findSvcToSvcGraphNodes
200

Graph nodes retrieved

No content

Maintenance

#
API
Description

1

GET /api/fetchParamsStatus

Fetches the status of parameters and configurations for maintenance purposes.

GET request for endpoint /api/fetchParamsStatus

get
Responses
chevron-right
200

Parameters status retrieved

No content

get
/api/fetchParamsStatus
200

Parameters status retrieved

No content

Last updated