---
title: "List benchmarks"
method: GET
path: "/v1/benchmarks"
tags: ["Benchmarks"]
---

# List benchmarks

`GET /v1/benchmarks`

## Request

- Base URL: `https://help.puppet.com/api/public`
- URL: `https://help.puppet.com/api/public/v1/benchmarks`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/puppet/apis/puppet-comply-api/docs/v1/benchmarks/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of all benchmarks.

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

## Response `200`

BenchmarksListResponse is the response for a list benchmarks request.

- Benchmark[]
  - `compatible_operating_systems` OperatingSystem[], required: The operating systems compatible with the benchmark.
    - `compatible_benchmarks` Compatiblebenchmark[], nullable: CompatibleBenchmarks for operating system.
      - `id` integer, required: The ID of the benchmark.
      - `name` string, required: The Name of the benchmark.
    - `id` integer, required: The ID of an operating system.
    - `name` string, required: The name of an operating system.
  - `id` integer, required: The ID of the benchmark.
  - `name` string, required: The name of the benchmark.
  - `profiles` Profile[], required: The profiles associated with the benchmark.
    - `benchmark` AssociatedBenchmark
      - `id` integer, required: The ID of the benchmark.
      - `name` string, required: The Name of the benchmark.
    - `id` integer, required: The ID of the profile.
    - `name` string, required: The name of the profile.

## Other responses

- `default`: ErrorResponse is the default error response.

---

[API](https://skmtc.dev/puppet/apis/puppet-comply-api.md) - [All operations](https://skmtc.dev/puppet/apis/puppet-comply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/puppet/apis/puppet-comply-api/revisions/0a7ac90117d7?raw)