Aqua Security · Schema

ContainerList

ContainerList schema from Aqua Security API

Cloud NativeContainersKubernetesRuntime ProtectionSecurityVulnerability Scanning

Properties

Name Type Description
count integer Total number of containers
result array
View JSON Schema on GitHub

JSON Schema

aqua-security-api-container-list-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "example": 50,
      "description": "Total number of containers"
    },
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "container_id": {
            "type": "string",
            "example": "abc123def456",
            "description": "Container ID"
          },
          "name": {
            "type": "string",
            "example": "web-server-1",
            "description": "Container name"
          },
          "image": {
            "type": "string",
            "example": "nginx:latest",
            "description": "Image name and tag"
          },
          "status": {
            "type": "string",
            "enum": [
              "running",
              "stopped",
              "paused"
            ],
            "example": "running",
            "description": "Container runtime status"
          },
          "policy": {
            "type": "string",
            "example": "default",
            "description": "Applied security policy name"
          },
          "host": {
            "type": "string",
            "example": "kube-node-01",
            "description": "Host running the container"
          }
        }
      }
    }
  },
  "$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-container-list-schema.json",
  "title": "ContainerList",
  "description": "ContainerList schema from Aqua Security API"
}