Sign in

v51

OpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-01133591927.1 KB
Scan Modes

Create scan mode

Creates a new scan mode with the provided configuration

post/api/scan-modes

Request body

namestring required

The name of the scan mode.

descriptionstring required

A description of the scan mode's purpose or behavior.

cronstring required

A cron expression defining the scan schedule.

Example request

{
  "name": "Daily Backup Scan",
  "description": "Scans for new backup data every day at midnight",
  "cron": "0 0 * * *"
}

Response

Scan mode created successfully

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the scan mode.

descriptionstring required

A description of the scan mode's purpose or behavior.

cronstring required

A cron expression defining the scan schedule.

Example response

{
  "id": "entity123",
  "createdBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "updatedBy": {
    "id": "abc123",
    "friendlyName": "John Doe (john.doe)"
  },
  "createdAt": "2023-10-31T12:34:56.789Z",
  "updatedAt": "2023-10-31T12:34:56.789Z",
  "name": "Daily Backup Scan",
  "description": "Scans for new backup data every day at midnight",
  "cron": "0 0 * * *"
}