List all checks.

GET 
/report/checks

List all checks.

Request

Query Parameters

provider string
Filter by provider.
Example: aws
service string
Filter by service.
Example: ec2
category string
Filter by category.
Example: security
kind string
Filter by kind.
Example: aws_ec2_instance
ids_only boolean

Filter by check ids.

id string
Filter by check ids.
Example: aws_ec2_public_ip_address,aws_ec2_old_instances

Responses

200

List of checks.

application/json

Schema

Schema

• Array [

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

result_kinds string[]

The kinds that are returned by this check.

risk string

The risk we are taking if we ignore this check

• ]

Example (from schema)

[
  {
    "id": "string",
    "provider": "string",
    "service": "string",
    "title": "string",
    "categories": [
      "string"
    ],
    "severity": "critical",
    "remediation": {
      "text": "string",
      "url": "string"
    },
    "url": "string",
    "related": [
      "string"
    ],
    "result_kinds": [
      "string"
    ],
    "risk": "string"
  }
]

Loading...