List available benchmarks.

GET 
/report/benchmarks

List available benchmarks.

Request

Query Parameters

benchmark string
Comma separated list of benchmarks. All if not defined.
Example: aws_cis_1_5,aws_cis_1_6
with_checks boolean

Include check definition into the benchmark

short boolean

Reduce the information to top level properties.

Responses

200

List of benchmarks.

application/json

Schema

Schema

• Array [
id string

The id of this benchmark

framework string

The framework of this benchmark

version string

The version of this benchmark

clouds string[]

The clouds relevant for this benchmark

report_checks object[]
Related checks of this benchmarks
Array [
oneOf
MOD1
string
InspectCheck
id string
The id of this check
provider string
The provider of this check
service string
The service of this check
title string
The title of this check
categories string[]
The categories of this check
severity string
Possible values: [critical, high, medium, low, info]
The severity of this check
detect
The detect expression of this check
property name* string
remediation object
text string
The text of the remediation
url string
The url of the remediation
action
Action to remediate the inspected issue
property name* string
url string
The url of this check
related string[]
The related checks of this check
]
• ]

Example (from schema)

[
  {
    "id": "string",
    "framework": "string",
    "version": "string",
    "clouds": [
      "string"
    ],
    "report_checks": [
      "string",
      {}
    ],
    "title": "string",
    "description": "string",
    "documentation": "string",
    "checks": [
      "string"
    ],
    "children": [
      null
    ]
  }
]

Loading...