---
title: "List exports"
method: GET
path: "/v1/exports"
tags: ["Exports"]
---

# List exports

`GET /v1/exports`

## Request

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

Retrieve a list of all exports.

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

## Response `200`

ExportsListResponse is the response for a list exports request.

- Export[]
  - `created_at` string, date-time, required: The time at which the export was created.
  - `description` string, required: A description of the export.
  - `export_file_location` string, required: The location of the export file for download.
  - `id` integer, required: The ID of the export.
  - `name` string, required: The name of the export.
  - `node_filters` NodeFilters, required: NodeFilters represents filters that determine which nodes will be included in the result. Nodes must match all specified filters to be included. If no filters are specified, all nodes will be included. Note that only nodes which have been appropriately classified and synchronized with Comply will be included.
    - `environments` string[], nullable: If specified, only nodes in at least one of the given environments will be included.
    - `name` string[], nullable: If specified, only the node with the given name will be included.
    - `node_groups` string[], nullable: If specified, only nodes in at least one of the given node groups will be included.
    - `operating_systems` string[], nullable: If specified, only nodes of the given operating systems will be included. Each operating system must be specified as a string with the name and version separated by a space.
  - `type` 'compliance_status_detailed' | 'compliance_status_summary', required: The type of the export.

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