Create or replace a check by its id.

PUT 
/report/check/:check_id

Create or replace a check by its id.

Request

Path Parameters

check_id stringrequired
The ID of the check to perform.
Example: aws_ec2_snapshot_encrypted

application/json

Body

The check to replace.

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

Responses

200

The checks result.

application/json

Schema

Schema

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...