# Get scans

URL: https://docs.hanzo.ai/docs/openapi/security/get-security-scans-by-id

> Returns one scan together with every finding on it, so the detail view is one round-trip rather than a list call per scan.

`GET /v1/security/scans/{id}`

> [Security →](https://docs.hanzo.ai/docs/openapi/security) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                               |
| ------------- | --------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/security/scans/{id}` |
| **Method**    | `GET`                                         |
| **Operation** | `get_security_scans_by_id`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`        |

Returns one scan together with every finding on it, so the detail view
is one round-trip rather than a list call per scan. The findings carry masked
previews and fingerprints, never secrets.

Scoped to the caller's org: a scan id belonging to another org is the same 404
as an id that never existed, so a ruleset learns nothing about what exists
elsewhere. No validated org is refused.

## Request

1 field.

| Field | In   | Type   | Required | Description                   |
| ----- | ---- | ------ | -------- | ----------------------------- |
| `id`  | path | string | yes      | ID is the scan the URL names. |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | security.scanDetail | ok      |
| `default` | problem-details     | refused |

`200` body — 21 fields.

| Field                    | In   | Type                    | Always | Description                                                                                                                                    |
| ------------------------ | ---- | ----------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `findings`               | body | security.findingView\[] | —      | Findings is every finding on that scan, so the detail view is one round-trip.                                                                  |
| `findings[].createdAt`   | body | integer (int64)         | —      | CreatedAt is when the finding was recorded, in Unix milliseconds.                                                                              |
| `findings[].fingerprint` | body | string                  | —      | Fingerprint is the SHA-256 of the raw secret.                                                                                                  |
| `findings[].id`          | body | string                  | —      | ID addresses this finding.                                                                                                                     |
| `findings[].line`        | body | integer (int64)         | —      | Line is where in that file.                                                                                                                    |
| `findings[].path`        | body | string                  | —      | Path is the file the secret was found in.                                                                                                      |
| `findings[].preview`     | body | string                  | —      | Preview is the secret MASKED — first and last characters kept, the middle starred — so a reviewer can recognise it without it being disclosed. |
| `findings[].ruleId`      | body | string                  | —      | RuleID is the detection rule that fired.                                                                                                       |
| `findings[].ruleName`    | body | string                  | —      | RuleName is that rule's human name.                                                                                                            |
| `findings[].scanId`      | body | string                  | —      | ScanID is the scan that produced it.                                                                                                           |
| `findings[].severity`    | body | string                  | —      | Severity ranks the finding: critical, high, medium or low.                                                                                     |
| `scan`                   | body | security.scanView       | —      |                                                                                                                                                |
| `scan.createdAt`         | body | integer (int64)         | —      | CreatedAt is when the scan ran, in Unix milliseconds.                                                                                          |
| `scan.critical`          | body | integer (int64)         | —      | Critical is how many findings carry the highest severity.                                                                                      |
| `scan.files`             | body | integer (int64)         | —      | Files is how many files the scan read.                                                                                                         |
| `scan.findings`          | body | integer (int64)         | —      | Findings is how many secrets fired across them.                                                                                                |
| `scan.high`              | body | integer (int64)         | —      | High is how many findings rank high.                                                                                                           |
| `scan.id`                | body | string                  | —      | ID addresses this scan and every finding on it.                                                                                                |
| `scan.low`               | body | integer (int64)         | —      | Low is how many findings rank low.                                                                                                             |
| `scan.medium`            | body | integer (int64)         | —      | Medium is how many findings rank medium.                                                                                                       |
| `scan.project`           | body | string                  | —      | Project is the sub-scope the scan was filed under.                                                                                             |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo security scans get <id>
```

**SDK**

**.ts**

```ts
import { Configuration, SecurityApi } from 'hanzoai';

const api = new SecurityApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSecurityScansById({ id: 'id' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SecurityApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SecurityApi(client).get_security_scans_by_id(id='id')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SecurityAPI.GetSecurityScansById(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, security_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = security_api::get_security_scans_by_id(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SecurityApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new SecurityApi(client).getSecurityScansById();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/security/scans/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **security** through the `security` tool, which names its 7 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_security_findings"
         }
       }
     }'
```

---

[Security API](https://docs.hanzo.ai/docs/openapi/security) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
