Scan operations

Scan operation API overview

A scan operation represents the execution of a discovery scan. It is required before importing external certificates into SCM. Each operation must be assigned a human-readable name.

Each operation includes:

A creation timestamp.
A status indicating whether the operation is in progress or completed.

Operations may include additional details (name/value).

These details are stored but not displayed in the SCM UI.
They help locate specific operations.
They provide useful context for tracking or auditing.

Note: Certificates imported under that operation become manageable in SCM once the scan operation is marked as completed.

Scan operation API endpoints

The following table lists the endpoints for managing scan operations. Click any endpoint name in the first column to open its API reference page.

Endpoint	Method	Path	Description
Get an operation	GET	`/api/v1/operations/{id}`	Retrieve details of a specific scan operation by its ID.
List operations	GET	`/api/v1/operations`	Retrieve multiple scan operations with filters and pagination.
Create an operation	POST	`/api/v1/operations`	Create a new scan operation and obtain its operation ID in the `Location` object of the response header.
Update an operation	PUT	`/api/v1/operations/{id}`	Update an operation’s status to `cancelled` or `completed`.
Delete an operation	DELETE	`/api/v1/operations/{id}`	Remove a specific operation by its ID.
Delete all operations	DELETE	`/api/v1/operations`	Remove all operations in a bucket.
Count operations	HEAD	`/api/v1/operations`	Count operations matching filters; total is returned in the `X-Total-Count` header.