Benchmarks

Retrieve a benchmark, including information about its associated profiles and compatible operating systems.

To use this endpoint, you must have one of the following roles: comply-admin comply-operator comply-viewer

get/v1/benchmarks/{id}

Request

Path parameters

idinteger required

The ID of the benchmark.

Response

GetBenchmarkResponse is the response for a get benchmark request.

idinteger required

The ID of the benchmark.

namestring required

The name of the benchmark.

Example response

{
  "compatible_operating_systems": [
    {
      "compatible_benchmarks": [
        {
          "id": 123,
          "name": "3.1.2 CIS CentOS Linux 7"
        }
      ],
      "id": 123,
      "name": "CentOS 7"
    }
  ],
  "id": 22,
  "name": "3.0.0 CIS Apple macOS 12.0 Monterey",
  "profiles": [
    {
      "benchmark": {
        "id": 123,
        "name": "3.1.2 CIS CentOS Linux 7"
      },
      "id": 123,
      "name": "Level 1 - Server"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.