clear.md

Clear

Abort any import operation currently in progress. Clear any remaining data that may have been left by any previous operation.

{% hint style="info" %} It requires the run-import permission. {% endhint %}

URL	Requires Auth	HTTP Method
/api/v1/import.clear	yes	POST

Headers

Argument	Example	Required	Description
X-User-Id	myuser-name	Required	The authenticated user ID.
X-Auth-Token	myauth-token	Required	Auth token.

Example Call

curl --location --request POST 'http://localhost:3000/api/v1/import.clear' \
--header 'x-auth-token: QizJozLOnWMi_2vWaLHhjfd-XYKT6XM40lTZ3zg1UMd' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ' \
--header 'Content-Type: application/json'

Example Result

Success

{
  "success": true
}

Error

• No Permission: This occurs when the authenticated user doesn't have the run-import permission.

{% tabs %} {% tab title="No Permission" %}

{
    "success": false,
    "error": "User does not have the permissions required for this action [error-unauthorized]"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
6.3.0	Added