PATCH

/v3/businesses/batch/start

This method will start the scan for all the content you included in the specific batch. Using this method, there is no need to start the scan process separately for each one of the processes.

You need to login with a user and api key in order to access this method.

Add this HTTP header to your request:

Authorization: Bearer <Your-Login-Token>

Not sure how to generate your login token? Read here .

Request

Body Parameters

Name

Description

triggerREQUIRED

A list of scans that you submitted for a check-credits scan and that you would like to submit for a full scan and also compare them against one another.

String array

Example: [ "Your-scan-id-1", "Your-scan-id-2" ]
This array can scan up to 100 submissions.

include

Include your documents from previous scans to compare against. These files will not be scanned, only compared against. The include list of scans must be available on the Copyleaks servers.

String array

Example: [ "Your-scan-id-3" ]
This array can scan up to 100 submissions.

errorHandling

When set to ignore (ignore = 1) the trigger scans will start running even if some of them are in error mode, when set to cancel (cancel = 0) the request will be cancelled if any error was found

Integer

Default Value:0

Possible Values:
0 : Cancel
1 : Ignore

Request Example

RAW

cURL

Python

Node.js

PHP

PATCH

https://api.copyleaks.com/v3/businesses/batch/start

Headers

Body

trigger:

0: "Your-scan-id-1"

1: "Your-scan-id-2"

include:

0: "Your-scan-id-3"

errorHandling: 0

Response

Codes

Status Code

Description

Example

200

The command was executed.

{
  "success": [
    "Your-scan-id"
  ],
  "failed": []
}

400

Bad request.

{
  "trigger": [
    "The trigger is required."
  ]
}

401

Unauthorized

Authorization has been denied for this request.

Other resources:

Performance Considerations ^Important! - How to improve your scan performance.

Exponential Backoff - Algorithm that helps applications define a retry strategy for consuming a network service.

Do you have a technical question?

Use stackoverflow.com to get help from our development team and other Copyleaks users.

Ask a Question