Compliance Requirements
curl --request POST \
--url https://api.wistx.ai/v1/compliance/requirements \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"resource_types": {},
"standards": {},
"severity": "<string>",
"include_remediation": true,
"include_verification": true
}
'import requests
url = "https://api.wistx.ai/v1/compliance/requirements"
payload = {
"resource_types": {},
"standards": {},
"severity": "<string>",
"include_remediation": True,
"include_verification": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource_types: {},
standards: {},
severity: '<string>',
include_remediation: true,
include_verification: true
})
};
fetch('https://api.wistx.ai/v1/compliance/requirements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wistx.ai/v1/compliance/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resource_types' => [
],
'standards' => [
],
'severity' => '<string>',
'include_remediation' => true,
'include_verification' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wistx.ai/v1/compliance/requirements"
payload := strings.NewReader("{\n \"resource_types\": {},\n \"standards\": {},\n \"severity\": \"<string>\",\n \"include_remediation\": true,\n \"include_verification\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wistx.ai/v1/compliance/requirements")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"resource_types\": {},\n \"standards\": {},\n \"severity\": \"<string>\",\n \"include_remediation\": true,\n \"include_verification\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wistx.ai/v1/compliance/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_types\": {},\n \"standards\": {},\n \"severity\": \"<string>\",\n \"include_remediation\": true,\n \"include_verification\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"controls": [
{
"control_id": "PCI-DSS-3.4",
"standard": "PCI-DSS",
"title": "Render PAN unreadable anywhere it is stored",
"description": "Render primary account numbers (PAN) unreadable anywhere they are stored...",
"severity": "CRITICAL",
"category": "Data Protection",
"subcategory": "Encryption",
"applies_to": ["RDS", "S3", "EC2"],
"remediation": {
"guidance": "Use encryption at rest for all databases storing PAN data...",
"code_examples": [
{
"language": "terraform",
"code": "resource \"aws_db_instance\" \"rds\" {\n storage_encrypted = true\n kms_key_id = \"arn:aws:kms:...\"\n}"
}
]
},
"verification": {
"procedures": [
"Check database encryption settings",
"Verify KMS key configuration",
"Review encryption logs"
]
},
"references": [
{
"title": "PCI-DSS Requirements",
"url": "https://www.pcisecuritystandards.org/..."
}
],
"source_url": "https://www.pcisecuritystandards.org/..."
}
],
"summary": {
"total": 45,
"by_severity": {
"CRITICAL": 12,
"HIGH": 18,
"MEDIUM": 10,
"LOW": 5
},
"by_standard": {
"PCI-DSS": 25,
"HIPAA": 20
}
},
"metadata": {
"query_time_ms": 234,
"filters_applied": {
"resource_types": ["RDS", "S3"],
"standards": ["PCI-DSS", "HIPAA"],
"severity": "HIGH"
}
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 234
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "At least one resource type is required"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"detail": "Invalid authorization header. Expected 'Bearer {api_key}'"
}
{
"detail": "Invalid or expired token"
}
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "Query quota exceeded",
"details": {
"limit_type": "queries_per_month",
"current": 50,
"limit": 50
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "DATABASE_ERROR",
"message": "Database connection failed",
"details": "Connection timeout"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
API Reference
Compliance Requirements
Get compliance requirements for infrastructure resources
POST
/
v1
/
compliance
/
requirements
Compliance Requirements
curl --request POST \
--url https://api.wistx.ai/v1/compliance/requirements \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"resource_types": {},
"standards": {},
"severity": "<string>",
"include_remediation": true,
"include_verification": true
}
'import requests
url = "https://api.wistx.ai/v1/compliance/requirements"
payload = {
"resource_types": {},
"standards": {},
"severity": "<string>",
"include_remediation": True,
"include_verification": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource_types: {},
standards: {},
severity: '<string>',
include_remediation: true,
include_verification: true
})
};
fetch('https://api.wistx.ai/v1/compliance/requirements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wistx.ai/v1/compliance/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'resource_types' => [
],
'standards' => [
],
'severity' => '<string>',
'include_remediation' => true,
'include_verification' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.wistx.ai/v1/compliance/requirements"
payload := strings.NewReader("{\n \"resource_types\": {},\n \"standards\": {},\n \"severity\": \"<string>\",\n \"include_remediation\": true,\n \"include_verification\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.wistx.ai/v1/compliance/requirements")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"resource_types\": {},\n \"standards\": {},\n \"severity\": \"<string>\",\n \"include_remediation\": true,\n \"include_verification\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wistx.ai/v1/compliance/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_types\": {},\n \"standards\": {},\n \"severity\": \"<string>\",\n \"include_remediation\": true,\n \"include_verification\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"controls": [
{
"control_id": "PCI-DSS-3.4",
"standard": "PCI-DSS",
"title": "Render PAN unreadable anywhere it is stored",
"description": "Render primary account numbers (PAN) unreadable anywhere they are stored...",
"severity": "CRITICAL",
"category": "Data Protection",
"subcategory": "Encryption",
"applies_to": ["RDS", "S3", "EC2"],
"remediation": {
"guidance": "Use encryption at rest for all databases storing PAN data...",
"code_examples": [
{
"language": "terraform",
"code": "resource \"aws_db_instance\" \"rds\" {\n storage_encrypted = true\n kms_key_id = \"arn:aws:kms:...\"\n}"
}
]
},
"verification": {
"procedures": [
"Check database encryption settings",
"Verify KMS key configuration",
"Review encryption logs"
]
},
"references": [
{
"title": "PCI-DSS Requirements",
"url": "https://www.pcisecuritystandards.org/..."
}
],
"source_url": "https://www.pcisecuritystandards.org/..."
}
],
"summary": {
"total": 45,
"by_severity": {
"CRITICAL": 12,
"HIGH": 18,
"MEDIUM": 10,
"LOW": 5
},
"by_standard": {
"PCI-DSS": 25,
"HIPAA": 20
}
},
"metadata": {
"query_time_ms": 234,
"filters_applied": {
"resource_types": ["RDS", "S3"],
"standards": ["PCI-DSS", "HIPAA"],
"severity": "HIGH"
}
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 234
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "At least one resource type is required"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"detail": "Invalid authorization header. Expected 'Bearer {api_key}'"
}
{
"detail": "Invalid or expired token"
}
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "Query quota exceeded",
"details": {
"limit_type": "queries_per_month",
"current": 50,
"limit": 50
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "DATABASE_ERROR",
"message": "Database connection failed",
"details": "Connection timeout"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Get compliance requirements for infrastructure resources (PCI-DSS, HIPAA, CIS, SOC2, NIST, ISO 27001)
Base URL:
The API playground will use this base URL by default. You can switch to
https://api.wistx.aiThe API playground will use this base URL by default. You can switch to
http://localhost:8000 for local development using the server selector above.Endpoint
curl --request POST \
--url https://api.wistx.ai/v1/compliance/requirements \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"resource_types": ["RDS", "S3"],
"standards": ["PCI-DSS", "HIPAA"],
"severity": "HIGH",
"include_remediation": true,
"include_verification": true
}'
import requests
api_key = "YOUR_API_KEY"
url = "https://api.wistx.ai/v1/compliance/requirements"
response = requests.post(
url,
headers={
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
},
json={
"resource_types": ["RDS", "S3"],
"standards": ["PCI-DSS", "HIPAA"],
"severity": "HIGH",
"include_remediation": True,
"include_verification": True
}
)
data = response.json()
print(data)
const apiKey = "YOUR_API_KEY";
const url = "https://api.wistx.ai/v1/compliance/requirements";
const response = await fetch(url, {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
resource_types: ["RDS", "S3"],
standards: ["PCI-DSS", "HIPAA"],
severity: "HIGH",
include_remediation: true,
include_verification: true
})
});
const data = await response.json();
console.log(data);
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
)
func main() {
apiKey := "YOUR_API_KEY"
url := "https://api.wistx.ai/v1/compliance/requirements"
payload := map[string]interface{}{
"resource_types": []string{"RDS", "S3"},
"standards": []string{"PCI-DSS", "HIPAA"},
"severity": "HIGH",
"include_remediation": true,
"include_verification": true,
}
jsonData, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", apiKey))
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)
fmt.Printf("%+v\n", result)
}
require 'net/http'
require 'json'
require 'uri'
api_key = "YOUR_API_KEY"
url = URI("https://api.wistx.ai/v1/compliance/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer #{api_key}"
request["Content-Type"] = "application/json"
request.body = {
resource_types: ["RDS", "S3"],
standards: ["PCI-DSS", "HIPAA"],
severity: "HIGH",
include_remediation: true,
include_verification: true
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$apiKey = "YOUR_API_KEY";
$url = "https://api.wistx.ai/v1/compliance/requirements";
$data = [
"resource_types" => ["RDS", "S3"],
"standards" => ["PCI-DSS", "HIPAA"],
"severity" => "HIGH",
"include_remediation" => true,
"include_verification" => true
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer " . $apiKey,
"Content-Type: application/json"
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
public class ComplianceRequest {
public static void main(String[] args) throws Exception {
String apiKey = "YOUR_API_KEY";
URL url = new URL("https://api.wistx.ai/v1/compliance/requirements");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Authorization", "Bearer " + apiKey);
conn.setRequestProperty("Content-Type", "application/json");
conn.setDoOutput(true);
JsonObject payload = new JsonObject();
payload.addProperty("severity", "HIGH");
payload.addProperty("include_remediation", true);
payload.addProperty("include_verification", true);
// Add arrays using Gson
Gson gson = new Gson();
String[] resourceTypes = {"RDS", "S3"};
String[] standards = {"PCI-DSS", "HIPAA"};
payload.add("resource_types", gson.toJsonTree(resourceTypes));
payload.add("standards", gson.toJsonTree(standards));
try (OutputStream os = conn.getOutputStream()) {
byte[] input = gson.toJson(payload).getBytes("utf-8");
os.write(input, 0, input.length);
}
BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream(), "utf-8"));
StringBuilder response = new StringBuilder();
String responseLine;
while ((responseLine = br.readLine()) != null) {
response.append(responseLine.trim());
}
System.out.println(response.toString());
}
}
Authorization
Request Body
List of resource types to check compliance for. Examples:
Maximum: 50 items
RDS, S3, EC2, Lambda, EKS, GKE, AKS, etc.Minimum: 1 itemMaximum: 50 items
Compliance standards to check. Supported standards:
Maximum: 20 items
PCI-DSS- Payment Card Industry Data Security StandardHIPAA- Health Insurance Portability and Accountability ActCIS- Center for Internet Security BenchmarksSOC2- Service Organization Control 2NIST-800-53- NIST Cybersecurity FrameworkISO-27001- ISO/IEC 27001 Information Security ManagementGDPR- General Data Protection RegulationFedRAMP- Federal Risk and Authorization Management Program
[] (all standards)Maximum: 20 items
Filter results by severity level.Options:
Default:
CRITICAL, HIGH, MEDIUM, LOWDefault:
null (all severities)Response
{
"data": {
"controls": [
{
"control_id": "PCI-DSS-3.4",
"standard": "PCI-DSS",
"title": "Render PAN unreadable anywhere it is stored",
"description": "Render primary account numbers (PAN) unreadable anywhere they are stored...",
"severity": "CRITICAL",
"category": "Data Protection",
"subcategory": "Encryption",
"applies_to": ["RDS", "S3", "EC2"],
"remediation": {
"guidance": "Use encryption at rest for all databases storing PAN data...",
"code_examples": [
{
"language": "terraform",
"code": "resource \"aws_db_instance\" \"rds\" {\n storage_encrypted = true\n kms_key_id = \"arn:aws:kms:...\"\n}"
}
]
},
"verification": {
"procedures": [
"Check database encryption settings",
"Verify KMS key configuration",
"Review encryption logs"
]
},
"references": [
{
"title": "PCI-DSS Requirements",
"url": "https://www.pcisecuritystandards.org/..."
}
],
"source_url": "https://www.pcisecuritystandards.org/..."
}
],
"summary": {
"total": 45,
"by_severity": {
"CRITICAL": 12,
"HIGH": 18,
"MEDIUM": 10,
"LOW": 5
},
"by_standard": {
"PCI-DSS": 25,
"HIPAA": 20
}
},
"metadata": {
"query_time_ms": 234,
"filters_applied": {
"resource_types": ["RDS", "S3"],
"standards": ["PCI-DSS", "HIPAA"],
"severity": "HIGH"
}
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 234
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "At least one resource type is required"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"detail": "Invalid authorization header. Expected 'Bearer {api_key}'"
}
{
"detail": "Invalid or expired token"
}
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "Query quota exceeded",
"details": {
"limit_type": "queries_per_month",
"current": 50,
"limit": 50
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "DATABASE_ERROR",
"message": "Database connection failed",
"details": "Connection timeout"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Response Fields
Response data containing compliance controls and summary.
Show Data properties
Show Data properties
List of compliance controls matching the query criteria.
Show Control object properties
Show Control object properties
Remediation guidance and code examples (included if
include_remediation is true).Show Remediation properties
Show Remediation properties
Examples
Get PCI-DSS Requirements for RDS
curl --request POST \
--url https://api.wistx.ai/v1/compliance/requirements \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"resource_types": ["RDS"],
"standards": ["PCI-DSS"],
"include_remediation": true
}'
import requests
response = requests.post(
"https://api.wistx.ai/v1/compliance/requirements",
headers={"Authorization": f"Bearer {api_key}"},
json={
"resource_types": ["RDS"],
"standards": ["PCI-DSS"],
"include_remediation": True
}
)
const response = await fetch("https://api.wistx.ai/v1/compliance/requirements", {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
resource_types: ["RDS"],
standards: ["PCI-DSS"],
include_remediation: true
})
});
Get Critical HIPAA Controls for S3
curl --request POST \
--url https://api.wistx.ai/v1/compliance/requirements \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"resource_types": ["S3"],
"standards": ["HIPAA"],
"severity": "CRITICAL",
"include_verification": true
}'
response = requests.post(
"https://api.wistx.ai/v1/compliance/requirements",
headers={"Authorization": f"Bearer {api_key}"},
json={
"resource_types": ["S3"],
"standards": ["HIPAA"],
"severity": "CRITICAL",
"include_verification": True
}
)
const response = await fetch("https://api.wistx.ai/v1/compliance/requirements", {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
resource_types: ["S3"],
standards: ["HIPAA"],
severity: "CRITICAL",
include_verification: true
})
});
Rate Limits
- Professional Plan: 2,000 queries/month
- Team Plan: 10,000 queries/month
- Enterprise Plan: Unlimited queries/month
X-RateLimit-Limit: Maximum requests allowedX-RateLimit-Remaining: Remaining requestsX-RateLimit-Reset: Unix timestamp when limit resets
Related Endpoints
- Knowledge Research - Research DevOps best practices
- Cost Search - Search infrastructure pricing
- Indexing - Index repositories and documentation