---
title: "List Operating Systems"
method: GET
path: "/v1/operating-systems"
tags: ["OperatingSystem"]
---

# List Operating Systems

`GET /v1/operating-systems`

## Request

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

Retrieve a list of all operating systems.

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

## Query parameters

- `name` string

## Response `200`

OperatingSystemsListResponse is the response for a list operating-systems request.

- OperatingSystem[]
  - `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.

## 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)