---
title: "Retrieve an export job"
method: GET
path: "/v1/export-job/{id}"
tags: ["Exports"]
---

# Retrieve an export job

`GET /v1/export-job/{id}`

## Request

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

Retrieve an export job, including its current status and the location of the associated export, if one has been
generated successfully.

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

## Path parameters

- `id` integer, required

## Response `200`

GetExportJobResponse is the response for a get export job request.

- object
  - `created_at` string, date-time, required: The time at which the export job was created.
  - `description` string, required: A description of the export to be generated.
  - `export_file_location` string, nullable: The location of the generated export file for download, if the export job has finished successfully.
  - `id` integer, required: The ID of the export job.
  - `name` string, required: The name of the export to be generated.
  - `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.
  - `status` 'queued' | 'processing' | 'successful' | 'failed', required: The status of the export job.
  - `type` 'compliance_status_detailed' | 'compliance_status_summary', required: The type of export to be generated.

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