BOOK A DEMO
LOGIN
Homekeyboard_arrow_rightDocumentationkeyboard_arrow_rightVersion 3keyboard_arrow_rightBusinesseskeyboard_arrow_rightDelete
PATCH

/v3.1/businesses/delete

Delete the specific process from the server.

Only completed processes can be deleted. All of the process results and information will be deleted.

The delete is prefromed in the background, the deleteion process can take few minutes.

lock 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
scansREQUIRED
The list of scans to delete
Object array
Example: [ {"id": "Your-scan-id-1"}, {"id": "Your-scan-id-2"} ]

Maximum length: 10,000 scans

purge
Delete all trace of the scan from Copyleaks server, including from internal database. A purged process will not be available as a result for previous scans.
Boolean
Default value:false
completionWebhook
Allows you to register to a webhook that will be fired once the removal has been completed.

Make sure that your endpoint is listening to a POST method (no body parameters were supplied).

string (uri)
Example:https://yoursite.com/webhook/deleted

Request Example

RAW
cURL
Python
C#
Node.js
PHP
PATCH
https://api.copyleaks.com/v3.1/businesses/delete
Headers
Body
scans:
0:
id: "Your-scan-id-1"
1:
id: "Your-scan-id-2"
purge: false

Response

Codes

Status Code
Description
Example
202
The request was placed for removal.

Note that this process is asynchronous. This means that the actual removal will take place once one of our servers will be free. In order to get notified after the command execution, register to webhook notification ( completionWebhook ).
400
Bad request.
{
  "scans": [
    "The scans is required."
  ]
}
401
Unauthorized

Authorization has been denied for this request.

Older versions

  • Delete V3

Other resources:

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

Do you have a technical question?

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

Ask a Question

PRODUCTS

Scans
Pricing
Copyleaks.com

RESOURCES

Documentation
Plagiarism Report
Help Center
System Status
Security

ABOUT

About us
Careers
Terms of Use
Privacy Policy
Sitemap

Copyleaks, Inc.

700 Canal St.
Stamford, CT 06902 USA

[email protected]

Copyleaks, Inc. All rights reserved. Use of this website signifies your agreement to the Terms of Use.

Copy