Skip to content
Copyleaks Documentation
Dashboard
Authenticity

Start Scans

PATCH https://api.copyleaks.com/v3/scans/start

Start scanning all the files you submitted for a price-check.

Request

Section titled “Request”

Headers

Section titled “Headers”
Content-Type: application/json
Authorization: Bearer YOUR_LOGIN_TOKEN

Request Body

Section titled “Request Body”

The request body is a JSON object containing the scans to start.

trigger array<string> required

A list of scans that you submitted for a check-credits scan and that you would like to submit for a full scan.

This array can scan up to 100 submissions.

Example: [ "Your-scan-id-1", "Your-scan-id-2" ]

errorHandling integer default: "0"

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. Possible Values: 0 (Cancel), 1 (Ignore).

Possible Values:

  • 0 : Cancel

  • 1 : Ignore

Responses

Section titled “Responses”
200 OK

The command was executed.

Response Schema

The response contains the following fields:

success array<string>
A list of scan IDs that were successfully started.
failed array<string>
A list of scan IDs that failed to start.

Example Response

A typical response from this endpoint:

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

Bad request.

Example Response

A typical response from this endpoint:

{
  "trigger": [
    "The trigger field is required.",
    "Cannot be null"
  ]
}

Examples

Section titled “Examples”
PATCH https://api.copyleaks.com/v3/scans/start
Content-Type: application/json
Authorization: Bearer YOUR_LOGIN_TOKEN


{
  "trigger": [
    "Your-scan-id-1",
    "Your-scan-id-2"
  ],
  "errorHandling": 0
}