Skip to main content
POST
Start a batch

Authorizations

x-preuve-key
string
header
required

API key id. Requests are additionally signed with x-preuve-timestamp, x-preuve-nonce, and x-preuve-signature (HMAC-SHA256) - see the Authentication guide.

Body

application/json
clientRunId
string
required

Idempotency id for the whole batch.

items
object[]
required
Required array length: 1 - 10 elements
name
string
scanType
enum<string>

Default scanType applied to every item; each item may override.

Available options:
free,
deep
enrichmentMode
enum<string>
Available options:
core,
none

Response

Batch created (or replayed via clientRunId).

id
string<uuid>
clientRunId
string
name
string | null
status
string
counts
object
items
object[]