Aqua Security · Schema

Policy

Policy schema from Aqua Security API

Cloud NativeContainersKubernetesRuntime ProtectionSecurityVulnerability Scanning

Properties

Name Type Description
name string Policy name
description string Policy description
block_failed boolean Whether to block containers that fail policy evaluation
maximum_score number Maximum CVSS score allowed (0-10)
View JSON Schema on GitHub

JSON Schema

aqua-security-api-policy-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "example": "default",
      "description": "Policy name"
    },
    "description": {
      "type": "string",
      "example": "Default security policy",
      "description": "Policy description"
    },
    "block_failed": {
      "type": "boolean",
      "example": true,
      "description": "Whether to block containers that fail policy evaluation"
    },
    "maximum_score": {
      "type": "number",
      "format": "float",
      "example": 7.0,
      "description": "Maximum CVSS score allowed (0-10)"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aqua-security/refs/heads/main/json-schema/aqua-security-api-policy-schema.json",
  "title": "Policy",
  "description": "Policy schema from Aqua Security API"
}