Perform a benchmark on a graph.

GET 
/report/benchmark/:benchmark/graph/:graph_id

Perform a benchmark with the given identifier on a graph with a given identifier.

Request

Path Parameters

graph_id stringrequired
The identifier of the graph
Example: fix
benchmark stringrequired
The name of the benchmark to perform
Example: aws_cis_1.5

Query Parameters

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
action string

Possible values: [run, load]

Default value: run

The action to perform. You can either run (create) or load the benchmark. Loading the benchmark requires, that a benchmark has been synchronized to the database before. In case the resources haven't changed since the last synchronization, the result is the same, but the load action is much faster.

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