Rapid7 Engines API

An Engine encapsulates the state and high-level attributes of the components which may be installed and running on a specific On-Premise host. The status of an Engine is not mutable via the API; it reflects the platform state of the components installed on the host, and can change at any given time. These states are: INITIALIZING : Engine is starting IDLE : Engine is waiting for scans LICENSING : Engine is checking a License has been assigned SCANNING : Engine is currently scanning UPGRADING : Engine is in the process of upgrading FAILED : Engine has failed in a process, with the reason shown in failure reason OFFLINE : Engine is not available TERMINATING : Engine is in the process of being deleted It should be noted that deleting an Engine resource is an asynchronous process, and actioning the request to delete the Engine occurs at the earliest convenience and is state-dependant. Creating a new Engine resource implicitly creates a Credential sub-resource, which is an alpha-numeric API key required for the successful installation and operation of an Engine in an On-Premise environment. An Engine API key can be retrieved by executing a get-engine-credential request, as documented below. CAUTION: regenerating an API key should only be performed when there is suspicion that the security of the API key has been compromised; regenerating will prevent any communication between any client using the revoked API key and the InsightAppSec Platform. Any manual Engine maintenance exercise which involves running the InsightAppSec Engine installer, should result in the creation of a NEW Engine; an API key should never be used across installations to prevent data loss/pollution and runtime issues. Please refer to help documentation which describes the process required to update the API for an existing installation.