How to Create a Custom Benchmark Via API

[refeed]

What is a custom benchmark?

Custom benchmark is a benchmark that can be created by the user. This is different with the predefined benchmarks that comes predefined by the StackGuardian Platform when creating a Connector.

How to create a custom benchmark via API?

For this, we will use the Update Connector API. The user will need the connector to be created beforehand.

Request Body

The request body is a JSON object that contains discovery configuration for custom benchmarks. Below is the schema:

Field	Type	Description	Example
DiscoverySettings	object	Contains benchmark configurations and custom checks.	See example below
benchmarks	object	A dictionary of benchmark settings.	Defined benchmarks below
benchmarks.<benchmark_id>	object	Specific benchmark configuration.	See example benchmark configurations. Custom benchmark should have a UUID format
runtimeSource	object/null	Source configuration for custom benchmarks (e.g., GitHub repos).	{"sourceConfigDestKind": "GITHUB_COM"}
checks	array	List of checks to be performed for each benchmark.	["aws_compliance.benchmark.hipaa"]
description	string	Detailed description of the benchmark.	"Health Insurance Portability..."
summaryDesc	string	Short summary of the benchmark purpose.	"The HIPAA Security Rule establishes..."
active	boolean	Flag to activate or deactivate the benchmark.	true
label	string	Short label for the benchmark.	"HIPAA"
isCustomCheck	boolean	Flag to indicate if this is a custom check.	true or false
summaryTitle	string	Title summarizing the benchmark.	"HIPAA Final Omnibus Security Rule 2013"
discoveryInterval	integer	Interval (in minutes) in which the benchmark discovery runs. (Set as 0 to disable).	0
isPrivate	boolean	Whether the source is private or not	true or false
auth	string	The secret id that needs to be used to get the repo	"/secrets/test_secret"

---

Example Request Body

{
  "DiscoverySettings": {
    "benchmarks": {
      "82356561-4f28-4fd9-82b8-b43f4c54284f": {
        "runtimeSource": {
          "sourceConfigDestKind": "GITHUB_COM",
          "config": {
            "repo": "https://github.com/turbot/steampipe-mod-aws-thrifty",
            "ref": "v0.29",
            "gitCoreAutoCRLF": false,
            "isPrivate": true,
            "auth": "/secrets/test-secret123"
          }
        },
        "checks": ["all"],
        "description": "AWS Cost Thrifty benchmark",
        "summaryDesc": "This benchmark makes sure that all of the resources are operated cost-effectively",
        "active": true,
        "label": "custom-thrifty",
        "isCustomCheck": true,
        "summaryTitle": "custom-thrifty",
        "discoveryInterval": 1440
      }
    }
  }
}