Perform a dynamically assembled benchmark on a graph.

GET 
/report/checks/graph/:graph_id

Perform a benchmark by defining the check criteria on a graph with a given identifier.

Request

Path Parameters

graph_id stringrequired
The identifier of the graph
Example: fix

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
accounts string
Comma separated list of account ids to include in the benchmark. If no value is given, all accounts are included.
Example: 123456789012,123456789013

Responses

200

The checks result.

application/ndjson

Schema

Schema

• Array [

oneOf

NodeInGraph

id string

The identifier of this node.

type string

reported

object

kind string

The kind of this node.

property name* any

desired

object

property name* any

metadata

object

property name* any

Edge

from string

The id of node to start from

to string

The id of the node to go to

edge_type string

Possible values: [default, delete]

The type of this edge

• ]

Example (from schema)

[
  {
    "type": "node",
    "id": "id-in-graph",
    "reported": {
      "kind": "test.person",
      "name": "Batman",
      "city": "Gotham"
    },
    "desired": {
      "clean": true
    },
    "metadata": {
      "version": 1
    }
  },
  {
    "type": "edge",
    "from": "node_id_of_a_in_graph",
    "to": "node_id_of_b_in_graph",
    "edge_type": "default"
  }
]

application/json

Schema

Schema

• Array [

oneOf

NodeInGraph

id string

The identifier of this node.

type string

reported

object

kind string

The kind of this node.

property name* any

desired

object

property name* any

metadata

object

property name* any

Edge

from string

The id of node to start from

to string

The id of the node to go to

edge_type string

Possible values: [default, delete]

The type of this edge

• ]

Example (from schema)

[
  {
    "type": "node",
    "id": "id-in-graph",
    "reported": {
      "kind": "test.person",
      "name": "Batman",
      "city": "Gotham"
    },
    "desired": {
      "clean": true
    },
    "metadata": {
      "version": 1
    }
  },
  {
    "type": "edge",
    "from": "node_id_of_a_in_graph",
    "to": "node_id_of_b_in_graph",
    "edge_type": "default"
  }
]

Loading...