PUT v1/account/permissions/{ProcessId:guid}/readonly

Generate a new access key to share the plagiarism report with others. If you already have a key, this new key will override the old one.

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.

Using the key

If your copyleaks-process id is 110d842a-e0bd-4d91-9c6e-ca42dc0958fc and access key is 3f1fTSIuw0myrb9GsSE9 then the URL will be:

Parameters

Input

NameDescriptionTypeAdditional information
ProcessId

The Id of the process to generate the access key for.

globally unique identifier

Required

Output

Successful HTTP response, indicated by status code Success (200), will contain a string with your readonly-key.

Example

Request

cURL

Sample:
curl -X PUT "https://api.copyleaks.com/v1/account/permissions/110d842a-e0bd-4d91-9c6e-ca42dc0958fc/readonly" \
     -H "Authorization: Bearer YOUR-TOKEN"

Response

plain/text

Sample:
3f1fTSIuw0myrb9GsSE9

Common Errors

Error Code Error Message
27 Unknown process id!
26 The request cannot be completed because the process is still running.
37 Authorization has been denied for this request.

For more information, see the full errors list.