Perform a dynamically assembled benchmark on a graph.
GEThttps://localhost:8900/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
- application/json
- Schema
- Example (from schema)
Schema
Array [
- NodeInGraph
- Edge
]
oneOf
id string
The identifier of this node.
type string
reported
object
desired
object
metadata
object
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
[
{
"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"
}
]
- Schema
- Example (from schema)
Schema
Array [
- NodeInGraph
- Edge
]
oneOf
id string
The identifier of this node.
type string
reported
object
desired
object
metadata
object
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
[
{
"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"
}
]
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
