---
title: "Scan Engine"
method: PUT
path: "/api/3/scan_engines/{id}"
tags: ["Scan Engine"]
---

# Scan Engine

`PUT /api/3/scan_engines/{id}`

Updates the specified scan engine.

## Path parameters

- `id` integer, required — The identifier of the scan engine.

## Request body

- ScanEngine — The specification of a scan engine.
  - `address` string, required — The address the scan engine is hosted.
  - `contentVersion` string — The content version of the scan engine.
  - `id` object — The identifier of the scan engine.
  - `isAWSPreAuthEngine` boolean — A boolean of whether the Engine is of type AWS Pre Authorized
  - `lastRefreshedDate` string, date-time — The date the engine was last refreshed. Date format is in ISO 8601.
  - `lastUpdatedDate` string, date-time — The date the engine was last updated. Date format is in ISO 8601.
  - `links` Link[], required — Hypermedia links to corresponding or related resources.
    - `deprecation` string
    - `href` string — A hypertext reference, which is either a URI (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>) or URI template (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc6570">RFC 6570</a>).
    - `hreflang` string
    - `media` string
    - `rel` string — The link relation type. This value is one from the <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5988#section-6.2">Link Relation Type Registry</a> or is the type of resource being linked to.
    - `title` string
    - `type` string
  - `name` string, required — The name of the scan engine.
  - `port` integer, required — The port used by the scan engine to communicate with the Security Console.
  - `productVersion` string — The product version of the scan engine.
  - `serialNumber` string — The serial number of the scan engine.
  - `sites` object[] — A list of identifiers of each site the scan engine is assigned to.
  - `status` 'active' | 'incompatible-version' | 'not-responding' | 'pending-authorization' | 'unknown' — The scan engine status. Can be one of the following values: | Value | Description | | ------------------------- | ------------------------------------------------------------------------------------------ | | `"active"` | The scan engine is active. | | `"incompatible-version"` | The product version of the remote scan engine is not compatible with the Security Console. | | `"not-responding"` | The scan engine is not responding to the Security Console. | | `"pending-authorization"` | The Security Console is not yet authorized to connect to the scan engine. | | `"unknown"` | The status of the scan engine is unknown. |

## Response `200`

OK

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/rapid7/apis/rapid7-vm-api.md) · [All operations](https://skmtc.net/rapid7/apis/rapid7-vm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rapid7/rapid7-vm-api/versions/3a8197c22d71/schema)