Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fetch Data

Table of Contents

Guardrails & Prompts

#
API
Description

1

POST /api/fetchThreatActors

Fetch guardrail actors (malicious sources) and their threat scores.

2

POST /api/fetchThreatApis

Retrieve Agentic components targeted by guardrails or malicious traffic.

3

POST /api/fetchThreatData

Fetch comprehensive Agentic Guardrail Activity and malicious attack data.

4

POST /api/fetchThreatTopNData

Get the top N Agentic Guardrail Activity or malicious activities by frequency or impact.

5

POST /api/fetchThreatCategoryCount

Get the count of Agentic Guardrails Policy Triggered events grouped by policy category.

6

POST /api/fetchThreatComplianceInfos

Retrieve Agentic Guardrails and threat compliance information.

7

POST /api/getIpReputationScore

Get the threat score for a specific IP address.

8

POST /api/fetchGuardrailPolicies

Fetch all configured Agentic Guardrails policies.

9

POST /api/fetchGuardrailData

Retrieve comprehensive Agentic Guardrails detection and response data.

10

POST /api/fetchAggregateMaliciousRequests

Fetch aggregated malicious Agentic Request data.

11

POST /api/getActorsCountPerCounty

Get the count of threat actors or malicious sources per country.

12

POST /api/getDailyThreatActorsCount

Retrieve the daily count of active Agentic Guardrails actors or malicious sources.

13

POST /api/fetchSessionContext

Fetch session context and metadata for Agentic Guardrails or malicious events.

14

POST /api/fetchSuspectSampleData

Fetch sample payloads from suspected malicious Agentic Requests.

15

POST /api/fetchCountBySeverity

Retrieve the count of Agentic Guardrails events grouped by severity level.

16

POST /api/fetchFiltersForThreatActors

Fetch filters for threat actors.

17

POST /api/fetchFiltersThreatTable

Fetch filters for threat detection table.

18

POST /api/fetchThreatActivityWebhookIntegration

Fetch Agentic Guardrail Activity webhook integration configuration.

19

POST /api/fetchThreatConfiguration

Fetch current threat detection configuration.

20

POST /api/fetchThreatsForActor

Fetch all threats detected for a specific actor.

21

POST /api/getThreatActivityTimeline

Get Agentic Guardrail Activity timeline for visualization.

22

POST /api/fetchCloudflareWafIntegration

Fetch Cloudflare WAF integration details.

23

POST /api/fetchAwsWafIntegration

Fetch AWS WAF integration details.

24

POST /api/fetchApiStats

Fetch Agentic Component statistics and metrics.

25

POST /api/fetchAdvancedFiltersForTraffic

Fetch all advanced traffic filters.

26

POST /api/getGuardrailTypes

Fetches all available guardrail types and their configurations.

27

POST /api/fetchAllPrompts

Fetches all saved system prompts and their configurations.

POST request for endpoint /api/fetchSuspectSampleData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

skipintegerOptionalDefault: 0Example: 0
limitintegerOptionalDefault: 50Example: 20
labelstring · enumOptionalExample: GUARDRAILPossible values:
statusFilterstring · enumOptionalExample: ACTIVEPossible values:
severitystring[]OptionalExample: ["HIGH","CRITICAL"]
ipsstring[]Optional
urlsstring[]Optional
hostsstring[]Optional
startTimestampintegerOptionalExample: 1712000000
endTimestampintegerOptionalExample: 1712100000
Responses
200

Paginated guardrail activity events

application/json

Sample description

totalinteger · int32OptionalExample: 150
post/api/fetchSuspectSampleData
POST /api/fetchSuspectSampleData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "skip": 0,
  "limit": 20,
  "label": "GUARDRAIL",
  "statusFilter": "ACTIVE",
  "severity": [
    "HIGH",
    "CRITICAL"
  ],
  "ips": [
    "text"
  ],
  "urls": [
    "text"
  ],
  "hosts": [
    "text"
  ],
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}
200

Paginated guardrail activity events

{
  "maliciousEvents": [
    {
      "id": "507f1f77bcf86cd799439011",
      "endpoint": "/api/users",
      "method": "POST",
      "ip": "192.168.1.1",
      "country": "US",
      "host": "api.example.com",
      "detectedAt": 1712000000,
      "status": "ACTIVE",
      "severity": "HIGH",
      "subCategory": "PII_DETECTED"
    }
  ],
  "total": 150
}

POST request for endpoint /api/fetchThreatActors

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

skipintegerOptionalDefault: 0Example: 0
cursorstringOptionalExample: 507f1f77bcf86cd799439011
startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
countrystring[]Optional
hoststring[]Optional
Responses
200

List of threat actors

application/json

Sample description

totalintegerOptionalExample: 25
cursorstringOptionalExample: 507f1f77bcf86cd799439013
post/api/fetchThreatActors
POST /api/fetchThreatActors HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "skip": 0,
  "cursor": "507f1f77bcf86cd799439011",
  "startTs": 1712000000,
  "endTs": 1712100000,
  "country": [
    "text"
  ],
  "host": [
    "text"
  ]
}
200

List of threat actors

{
  "actors": [
    {
      "id": "507f1f77bcf86cd799439011",
      "objectId": "507f1f77bcf86cd799439012",
      "latestApiEndpoint": "/api/users",
      "latestApiIp": "203.0.113.5",
      "latestApiMethod": "POST",
      "country": "US",
      "latestSubcategory": "SQL_INJECTION",
      "discoveredAt": 1712000000
    }
  ],
  "total": 25,
  "cursor": "507f1f77bcf86cd799439013"
}

POST request for endpoint /api/fetchAggregateMaliciousRequests

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

eventIdstringOptionalExample: 507f1f77bcf86cd799439011
labelstring · enumOptionalExample: GUARDRAILPossible values:
Responses
200

Event details with full payload

application/json

Sample description

post/api/fetchAggregateMaliciousRequests
POST /api/fetchAggregateMaliciousRequests HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "eventId": "507f1f77bcf86cd799439011",
  "label": "GUARDRAIL"
}
200

Event details with full payload

{
  "maliciousPayloadsResponses": [
    {
      "eventId": "507f1f77bcf86cd799439011",
      "endpoint": "/api/users",
      "method": "POST",
      "requestPayload": "null",
      "responsePayload": "null",
      "blockedBy": "PII_DETECTION",
      "detectedThreats": [
        "text"
      ],
      "timestamp": 1712000000
    }
  ]
}

POST request for endpoint /api/fetchCountBySeverity

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

Threat counts by severity

application/json

Sample description

post/api/fetchCountBySeverity
POST /api/fetchCountBySeverity HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

Threat counts by severity

{
  "categoryCounts": [
    {
      "displayName": "CRITICAL",
      "count": 12
    }
  ]
}

POST request for endpoint /api/fetchThreatApis

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

skipintegerOptionalDefault: 0Example: 0
startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

List of threatened APIs

application/json

Sample description

totalintegerOptionalExample: 15
post/api/fetchThreatApis
POST /api/fetchThreatApis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "skip": 0,
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

List of threatened APIs

{
  "apis": [
    {
      "endpoint": "/api/users",
      "method": "POST",
      "host": "api.example.com",
      "actorsCount": 5,
      "requestsCount": 25,
      "discoveredAt": 1712000000
    }
  ],
  "total": 15
}

POST request for endpoint /api/fetchThreatCategoryCount

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

Threat counts by category

application/json

Sample description

post/api/fetchThreatCategoryCount
POST /api/fetchThreatCategoryCount HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

Threat counts by category

{
  "categoryCounts": [
    {
      "displayName": "SQL Injection",
      "subCategory": "SQL_INJECTION",
      "count": 15
    }
  ]
}

POST request for endpoint /api/getDailyThreatActorsCount

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

Daily threat actor counts

application/json

Sample description

totalAnalysedintegerOptionalExample: 50
totalAttacksintegerOptionalExample: 75
totalCriticalActorsintegerOptionalExample: 8
totalActiveStatusintegerOptionalExample: 5
totalIgnoredStatusintegerOptionalExample: 2
totalUnderReviewStatusintegerOptionalExample: 1
post/api/getDailyThreatActorsCount
POST /api/getDailyThreatActorsCount HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

Daily threat actor counts

{
  "actorsCounts": [
    {
      "ts": 1712000000,
      "totalActors": 10,
      "criticalActors": 3
    }
  ],
  "totalAnalysed": 50,
  "totalAttacks": 75,
  "totalCriticalActors": 8,
  "totalActiveStatus": 5,
  "totalIgnoredStatus": 2,
  "totalUnderReviewStatus": 1
}

POST request for endpoint /api/getActorsCountPerCounty

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

Threat actor counts per country

application/json

Sample description

post/api/getActorsCountPerCounty
POST /api/getActorsCountPerCounty HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

Threat actor counts per country

{
  "actorsCountPerCountry": [
    {
      "code": "US",
      "subCategoryWiseDataList": [
        {
          "subCategory": "SQL_INJECTION",
          "activityCount": 5
        }
      ]
    }
  ]
}

POST request for endpoint /api/fetchRemediationInfo

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

issueIdstringOptionalExample: null
Responses
200

description

application/json

Sample description

remediationInfostringOptionalExample: null
remediationCodestringOptionalExample: null
post/api/fetchRemediationInfo
POST /api/fetchRemediationInfo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "issueId": "null"
}
200

description

{
  "remediationInfo": "null",
  "remediationCode": "null"
}

POST request for endpoint /api/fetchGuardrailPolicies

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional

Sample description

Responses
200

List of guardrail policies

application/json

Sample description

totalinteger · int32OptionalExample: 5
post/api/fetchGuardrailPolicies
POST /api/fetchGuardrailPolicies HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

List of guardrail policies

{
  "guardrailPolicies": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "name": "PII Detection Policy",
      "description": "Detect and block requests containing sensitive PII",
      "severity": "HIGH",
      "active": true,
      "contextSource": "API",
      "createdBy": "admin@example.com",
      "createdTimestamp": 1712000000,
      "updatedTimestamp": 1712100000,
      "piiTypes": [
        "text"
      ]
    }
  ],
  "total": 5
}

POST request for endpoint /api/fetchSessionContext

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

sessionIdstringOptionalExample: session-uuid-12345
namestringOptionalExample: Extension Config
enabledbooleanOptionalExample: true
extensionIdstringOptionalExample: ext-id-123
apiKeystringOptionalExample: api-key-value
configurationobjectOptional
Responses
200

Count of protected endpoints

application/json

Sample description

protectedApisCountintegerOptionalExample: 42
totalApisCountintegerOptionalExample: 100
percentageProtectednumber · doubleOptionalExample: 42
post/api/fetchSessionContext
POST /api/fetchSessionContext HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "sessionId": "session-uuid-12345",
  "name": "Extension Config",
  "enabled": true,
  "extensionId": "ext-id-123",
  "apiKey": "api-key-value",
  "configuration": {}
}
200

Count of protected endpoints

{
  "protectedApisCount": 42,
  "totalApisCount": 100,
  "percentageProtected": 42
}

POST request for endpoint /api/fetchThreatData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTimestampintegerOptionalExample: 1712000000
endTimestampintegerOptionalExample: 1712100000
Responses
200

Consolidated threat metrics

application/json

Sample description

post/api/fetchThreatData
POST /api/fetchThreatData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}
200

Consolidated threat metrics

{
  "response": {
    "threatsBySeverity": {
      "critical": 5,
      "high": 12,
      "medium": 8,
      "low": 3,
      "total": 28
    },
    "topThreatsByCategory": [
      {}
    ],
    "topAttackHosts": [
      {}
    ],
    "topBadActors": [
      {}
    ]
  }
}

POST request for endpoint /api/fetchGuardrailData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTimestampintegerOptionalExample: 1712000000
endTimestampintegerOptionalExample: 1712100000
Responses
200

Consolidated guardrail metrics

application/json

Sample description

post/api/fetchGuardrailData
POST /api/fetchGuardrailData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "startTimestamp": 1712000000,
  "endTimestamp": 1712100000
}
200

Consolidated guardrail metrics

{
  "response": {
    "topGuardrailPolicies": [
      {}
    ],
    "dataProtectionTrends": [
      {}
    ],
    "avgThreatScore": 6.5,
    "sensitiveCount": 45,
    "successfulExploits": 3,
    "complianceAtRisks": [
      {}
    ],
    "attackFlows": [
      {}
    ]
  }
}

POST request for endpoint /api/fetchThreatTopNData

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

Top N threatened resources

application/json

Sample description

post/api/fetchThreatTopNData
POST /api/fetchThreatTopNData HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

Top N threatened resources

{
  "topApis": [
    {
      "endpoint": "/api/users",
      "method": "POST",
      "attacks": 25,
      "severity": "HIGH"
    }
  ],
  "topHosts": [
    {
      "host": "api.example.com",
      "attacks": 45
    }
  ]
}

POST request for endpoint /api/fetchThreatComplianceInfos

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

startTsintegerOptionalExample: 1712000000
endTsintegerOptionalExample: 1712100000
Responses
200

Compliance-related threat data

application/json

Sample description

threatComplianceInfosobject[]Optional

Compliance threat mapping data

post/api/fetchThreatComplianceInfos
POST /api/fetchThreatComplianceInfos HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "startTs": 1712000000,
  "endTs": 1712100000
}
200

Compliance-related threat data

{
  "threatComplianceInfos": [
    {}
  ]
}

POST request for endpoint /api/getIpReputationScore

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body

Sample description

ipstringOptionalExample: 203.0.113.5
Responses
200

IP reputation information

application/json

Sample description

ipstringOptionalExample: 203.0.113.5
reputationScorenumber · doubleOptionalExample: 7.5
threatLevelstring · enumOptionalExample: HIGHPossible values:
isBlacklistedbooleanOptionalExample: false
countrystringOptionalExample: US
ispstringOptionalExample: Example ISP
threatTypesstring[]Optional
post/api/getIpReputationScore
POST /api/getIpReputationScore HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "ip": "203.0.113.5"
}
200

IP reputation information

{
  "ip": "203.0.113.5",
  "reputationScore": 7.5,
  "threatLevel": "HIGH",
  "isBlacklisted": false,
  "country": "US",
  "isp": "Example ISP",
  "threatTypes": [
    "text"
  ]
}

POST request for endpoint /api/fetchFiltersForThreatActors

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Threat actor filters retrieved successfully

application/json
post/api/fetchFiltersForThreatActors
POST /api/fetchFiltersForThreatActors HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Threat actor filters retrieved successfully

{
  "actorFilters": [
    {
      "ip": "192.0.2.48",
      "country": "IN",
      "status": "active"
    }
  ]
}

POST request for endpoint /api/fetchFiltersThreatTable

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Threat table filters retrieved successfully

application/json
post/api/fetchFiltersThreatTable
POST /api/fetchFiltersThreatTable HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Threat table filters retrieved successfully

{
  "filters": [
    {
      "id": "High4XXAlertFilter",
      "name": "High 4XX Alert",
      "category": "RL"
    }
  ]
}

POST request for endpoint /api/fetchThreatActivityWebhookIntegration

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Threat activity webhook integration retrieved successfully

application/json
webhookUrlstringOptionalExample: https://[YOUR_SYSTEM_DOMAIN]/webhooks/threat-activity
enabledbooleanOptionalExample: true
eventTypesstring[]OptionalExample: ["ANOMALY_DETECTED","RATE_LIMIT_EXCEEDED","BOLA_DETECTED"]
createdAtintegerOptionalExample: 1672531200
post/api/fetchThreatActivityWebhookIntegration
POST /api/fetchThreatActivityWebhookIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Threat activity webhook integration retrieved successfully

{
  "webhookUrl": "https://[YOUR_SYSTEM_DOMAIN]/webhooks/threat-activity",
  "enabled": true,
  "eventTypes": [
    "ANOMALY_DETECTED",
    "RATE_LIMIT_EXCEEDED",
    "BOLA_DETECTED"
  ],
  "createdAt": 1672531200
}

POST request for endpoint /api/fetchThreatConfiguration

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Threat configuration retrieved successfully

application/json
post/api/fetchThreatConfiguration
POST /api/fetchThreatConfiguration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Threat configuration retrieved successfully

{
  "ratelimitConfig": {
    "rules": [
      {
        "name": "Global Rate Limit Rule",
        "period": 5,
        "maxRequests": 100,
        "mitigationPeriod": 5,
        "action": "BLOCK",
        "type": "DEFAULT",
        "behaviour": "DYNAMIC"
      }
    ]
  }
}

POST request for endpoint /api/fetchThreatsForActor

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
actorstringOptionalExample: 192.0.2.48
Responses
200

Threats for actor retrieved successfully

application/json
post/api/fetchThreatsForActor
POST /api/fetchThreatsForActor HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "actor": "192.0.2.48"
}
200

Threats for actor retrieved successfully

{
  "threats": [
    {
      "_id": "4a3502a0-ab5f-4255-9628-aae3b0ef33bd",
      "actor": "192.0.2.48",
      "category": "RL",
      "subCategory": "Rate Limiting",
      "severity": "HIGH",
      "detectedAt": 1672531200,
      "type": "Anomaly"
    }
  ]
}

POST request for endpoint /api/getThreatActivityTimeline

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
startTimeintegerOptionalExample: 1672531200
endTimeintegerOptionalExample: 1672531200
Responses
200

Threat activity timeline retrieved successfully

application/json
totalThreatsDetectedintegerOptionalExample: 994
post/api/getThreatActivityTimeline
POST /api/getThreatActivityTimeline HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "startTime": 1672531200,
  "endTime": 1672531200
}
200

Threat activity timeline retrieved successfully

{
  "timeline": [
    {
      "timestamp": 1672531200,
      "severity": "HIGH",
      "threatCount": 5,
      "category": "RL"
    }
  ],
  "totalThreatsDetected": 994
}

POST request for endpoint /api/fetchCloudflareWafIntegration

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Cloudflare WAF integration details retrieved successfully

application/json
post/api/fetchCloudflareWafIntegration
POST /api/fetchCloudflareWafIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Cloudflare WAF integration details retrieved successfully

{
  "integrations": [
    {
      "integrationId": "cf_integration_123",
      "zoneId": "[ZONE_ID_REDACTED]",
      "status": "active",
      "createdAt": 1672531200
    }
  ]
}

POST request for endpoint /api/fetchAwsWafIntegration

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

AWS WAF integration details retrieved successfully

application/json
post/api/fetchAwsWafIntegration
POST /api/fetchAwsWafIntegration HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

AWS WAF integration details retrieved successfully

{
  "integrations": [
    {
      "integrationId": "aws_integration_456",
      "region": "us-east-1",
      "status": "active",
      "lastSync": 1672531200
    }
  ]
}

POST request for endpoint /api/fetchApiStats

post
Body
objectOptional
Responses
200

API statistics retrieved

No content
post/api/fetchApiStats
POST /api/fetchApiStats HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

API statistics retrieved

No content

POST request for endpoint /api/fetchAdvancedFiltersForTraffic

post
Header parameters
content-typestringOptionalExample: application/json
X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs
Body
objectOptional
Responses
200

Advanced filters retrieved successfully

application/json
totalCountintegerOptionalExample: 54
post/api/fetchAdvancedFiltersForTraffic
POST /api/fetchAdvancedFiltersForTraffic HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200

Advanced filters retrieved successfully

{
  "filters": [
    {
      "_id": "LocalFileInclusionLFIRFI",
      "author": "AKTO",
      "source": "AKTO_TEMPLATES",
      "createdAt": 1672531200,
      "inactive": false
    }
  ],
  "totalCount": 54
}

POST request for endpoint /api/getGuardrailTypes

post
Body
objectOptional
Responses
200

Guardrail types retrieved successfully

application/json
post/api/getGuardrailTypes
POST /api/getGuardrailTypes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "guardrailTypes": [
    {
      "type": "cursor-hooks",
      "displayName": "Cursor IDE Hooks",
      "description": "Install Akto guardrails hooks for Cursor IDE"
    },
    {
      "type": "openclaw-guardrails",
      "displayName": "OpenClaw Guardrails",
      "description": "Install MCP Endpoint Shield guardrails for OpenClaw (Clawdbot)",
      "envVars": [
        {
          "name": "OPENAI_API_KEY",
          "label": "OpenAI API Key",
          "placeholder": "sk-xxxxx",
          "required": "true"
        },
        {
          "name": "ORIGINAL_PROVIDER",
          "label": "Original Provider",
          "placeholder": "openai/gpt-4o-mini",
          "required": "true"
        },
        {
          "name": "MODEL_ID",
          "label": "Model ID",
          "placeholder": "gpt-4o-mini",
          "required": "true"
        }
      ]
    },
    {
      "type": "claude-cli-hooks",
      "displayName": "Claude CLI Hooks",
      "description": "Monitor and secure Claude AI CLI assistant"
    }
  ]
}

POST request for endpoint /api/fetchAllPrompts

post
Body
objectOptional
Responses
200

Prompt templates retrieved successfully

application/json
post/api/fetchAllPrompts
POST /api/fetchAllPrompts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "promptsObj": {
    "customPrompts": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "label": "Block Prompt Injection",
          "value": "custom-prompt-injection-v1",
          "category": "Injection Attacks",
          "inactive": false
        }
      ]
    },
    "aktoPrompts": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "label": "Detect Jailbreak Attempts",
          "value": "akto-jailbreak-detection-v2",
          "category": "Jailbreak",
          "inactive": false
        }
      ]
    },
    "mapPromptToData": {
      "ANY_ADDITIONAL_PROPERTY": {
        "content": "id: detect-jailbreak\ninfo:\n  name: Detect Jailbreak\n  severity: HIGH\n...",
        "category": "Jailbreak",
        "name": "Detect Jailbreak Attempts",
        "description": "Detects attempts to bypass AI safety guidelines",
        "severity": "HIGH"
      }
    },
    "mapIdtoPrompt": {
      "akto-jailbreak-detection-v2": "Detect Jailbreak Attempts",
      "custom-prompt-injection-v1": "Block Prompt Injection"
    },
    "totalCustomPrompts": 3,
    "totalAktoPrompts": 12
  }
}
PreviousAgentic Guardrails
NextModify Data

Last updated