Skip to Content
API ReferenceGenerate Rules

Generate Rules

POST /v1/generate

Start a pipeline execution to generate Sigma detection rules from threat intelligence. The pipeline extracts MITRE ATT&CK TTPs, generates Sigma rules grounded against a gold corpus, validates them with pySigma, and converts them to SIEM-native queries.

Authentication

Requires Bearer token (JWT or API key).

Authorization: Bearer <token>

Request Body

FieldTypeRequiredDescription
inputTypestringYesOne of: url, cve, text
urlstringIf inputType is urlThreat advisory or blog URL
cveIdstringIf inputType is cveCVE identifier (e.g., CVE-2025-1974)
textstringIf inputType is textRaw threat intelligence text (max 50,000 chars)
options.targetProvidersstring[]NoTarget platforms. Default: all 13 platforms
options.targetSiemsstring[]NoSIEM backends for conversion. Default: all
options.includeIocRulesbooleanNoGenerate IOC-based rules in addition to behavioral. Default: true
options.forcebooleanNoSkip cache and regenerate. Default: false

Provide exactly one of url, cveId, or text based on inputType.

Target Providers

Valid values for options.targetProviders:

aws, gcp, azure, windows-sysmon, windows-security, windows-powershell, linux-auditd, kubernetes-audit, okta, entra-id-signin, entra-id-audit, modsecurity, aws-waf

See Supported Platforms for details on each.

Target SIEMs

Valid values for options.targetSiems:

splunk, sentinel, elasticsearch, chronicle, opensearch, google_secops

Example Request

curl -X POST https://cloudsigma.a13e.com/v1/generate \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "inputType": "url", "url": "https://www.cisa.gov/news-events/cybersecurity-advisories/aa24-242a", "options": { "targetProviders": ["aws", "gcp", "azure"], "targetSiems": ["splunk", "sentinel"], "includeIocRules": true } }'

Response

The endpoint starts an asynchronous pipeline and returns immediately with an execution ARN. Use the Status endpoint to poll for results.

{ "success": true, "data": { "executionArn": "arn:aws:states:REGION:ACCOUNT_ID:execution:CloudSigmaPipeline:abc-123" } }

Pipeline Output (via Status Endpoint)

When the pipeline completes, the status endpoint returns the full output:

{ "rules": [ { "yaml": "title: AWS IAM Access Key Creation\nstatus: experimental\nlogsource:\n product: aws\n service: cloudtrail\ndetection:\n selection:\n eventName: CreateAccessKey\n condition: selection\nlevel: medium\ntags:\n - attack.persistence\n - attack.t1098.001", "title": "AWS IAM Access Key Creation", "conversions": { "splunk": "index=cloudtrail eventName=\"CreateAccessKey\"", "sentinel": "CloudTrailLogs | where EventName == \"CreateAccessKey\"" } } ], "ttps": [ { "techniqueId": "T1098.001", "techniqueName": "Account Manipulation: Additional Cloud Credentials", "tactic": "Persistence", "confidence": "high" } ], "iocs": [], "detectionGaps": [], "pipelineNotices": [], "metadata": { "inputType": "url", "rulesGenerated": 5, "ttpsExtracted": 8, "platformsTargeted": 3, "processingTimeMs": 12500 } }

Errors

HTTPCodeDescriptionResolution
400InvalidInputTypeUnknown inputType valueUse url, cve, or text
400ValidationErrorMissing required fieldCheck request body
401UnauthorizedInvalid or missing tokenCheck Authentication
429RateLimitExceededMore than 5 requests/minuteWait and retry
429TierLimitExceededMonthly rule limit reachedUpgrade your plan 
500PipelineFailedInternal pipeline errorRetry; contact support if persistent

The pipeline typically completes in 10–30 seconds depending on input complexity and the number of target platforms.

Last updated on