> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--scan/types/objects/scan-response.md).

# scanResponse

Response containing information about a triggered scan.

### Examples

```graphql
type ScanResponse {
  scanID: String
  isFullScan: Boolean
  isContainerFullScan: Boolean
  isSingleRepoScan: Boolean
  isDastFullScan: Boolean
  isDastOnlyScan: Boolean
  scannerTag: String
  isCspmScopedScan: Boolean
  alreadyRunning: Boolean
  runningScanType: String
  refusedAssets: [RefusedRescanAsset!]
}
```

### Fields

| Field                                                                                                                                             | Description                                                                                        | Supported fields                                                                                                                                                                                                              |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| scanID `String`                                                                                                                                   | Unique identifier for tracking the scan progress                                                   |                                                                                                                                                                                                                               |
| isFullScan `Boolean`                                                                                                                              | Indicates if this is a full code scan rather than an incremental scan                              |                                                                                                                                                                                                                               |
| isContainerFullScan `Boolean`                                                                                                                     | Indicates if this is a full container scan rather than an incremental scan                         |                                                                                                                                                                                                                               |
| isSingleRepoScan `Boolean`                                                                                                                        | Indicates if this is a scan of a single repository                                                 |                                                                                                                                                                                                                               |
| isDastFullScan `Boolean`                                                                                                                          | Indicates if this is a full DAST scan rather than an incremental scan                              |                                                                                                                                                                                                                               |
| isDastOnlyScan `Boolean`                                                                                                                          | Indicates if this is a DAST-only scan                                                              |                                                                                                                                                                                                                               |
| scannerTag `String`                                                                                                                               | Scanner image tag                                                                                  |                                                                                                                                                                                                                               |
| isCspmScopedScan `Boolean`                                                                                                                        | Indicates if this is an on-demand rescan of cloud assets                                           |                                                                                                                                                                                                                               |
| alreadyRunning `Boolean`                                                                                                                          | True when another scan was already running, so nothing new was queued; scanID is that running scan |                                                                                                                                                                                                                               |
| runningScanType `String`                                                                                                                          | Kind of the already-running scan: regular, singleRepo, dastOnly or cspmRescan                      |                                                                                                                                                                                                                               |
| refusedAssets [`[RefusedRescanAsset!]`](https://docs.ox.security/api-documentation/api-reference/api--scan/types/objects/refused-rescan-asset.md) | Assets of a cloud asset rescan that were left out, each with the reason; the rest were queued      | <p>cbomId <code>String!</code><br>code <a href="https://docs.ox.security/api-documentation/api-reference/api--scan/types/enums/rescan-refusal-code.md"><code>RescanRefusalCode!</code></a><br>reason <code>String!</code></p> |

### References

#### Mutations using this object:

* [<\~> scanAll](https://docs.ox.security/api-documentation/api-reference/api--scan/mutations/scan-all.md)
* [<\~> singleRepoScan](https://docs.ox.security/api-documentation/api-reference/api--scan/mutations/single-repo-scan.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ox.security/api-documentation/api-reference/api--scan/types/objects/scan-response.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
