---
title: "Retrieve a scan."
method: GET
path: "/v1/scan/{id}"
tags: ["Scan"]
---

# Retrieve a scan.

`GET /v1/scan/{id}`

## Request

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

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

## Path parameters

- `id` string, required

## Response `200`

GetScanResponse is the response for a scan.

- object
  - `created_at` string, date-time, required: The time at which the scan was created.
  - `errored` integer, required: The number of nodes that errored in scan.
  - `failed` integer, required: The number of nodes that failed in scan.
  - `finished` integer, required: The number of nodes that finished in scan.
  - `finished_at` string, date-time, nullable: The time at which the scan finished.
  - `id` string, required: The ID of the scan.
  - `name` string, required: The name of the scan.
  - `nodes_scanned` integer, required: The number of nodes scanned.
  - `status` 'started' | 'finished' | 'failed', required: The status of the inventory sync job.
  - `type` string, required: The type of scan.

## Other responses

- `400`: ScanNotFound is returned when scan with provided id does not exist.
- `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)