mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-07-19 02:21:52 +00:00
pedrooot
36 lines
535 B
Plaintext
36 lines
535 B
Plaintext
---
|
|
title: "Update Scan"
|
|
api: "PATCH /api/v1/scans/{id}"
|
|
description: "Update scan metadata."
|
|
---
|
|
|
|
Update a scan's name or other mutable fields.
|
|
|
|
## Path Parameters
|
|
|
|
- `id` (required) - UUID of the scan to update
|
|
|
|
## Request Body
|
|
|
|
```json
|
|
{
|
|
"data": {
|
|
"type": "scans",
|
|
"id": "scan-uuid",
|
|
"attributes": {
|
|
"name": "Updated Scan Name"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Response
|
|
|
|
### Success Response (200 OK)
|
|
|
|
Returns the updated scan.
|
|
|
|
<Note>
|
|
Only the `name` field can be updated. State and execution details are read-only.
|
|
</Note>
|