Create New Import Operation

Prev Next
Post
/api/v1/import.new

Creates a new import operation; if an operation was already running, it will be aborted. Any data from previous imports will be cleared automatically. Permission required: run-import

Changelog

Version Description
6.3.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200

OK

Success
{
  "operation": {
    "_id": "64d69545ee8ae821983005f5",
    "type": "api",
    "importerKey": "api",
    "ts": "2023-08-11T20:08:37.655Z",
    "status": "importer_new",
    "valid": true,
    "user": "rbAXPnMktTFbNpwtJ",
    "_updatedAt": "2023-08-11T20:08:37.655Z"
  },
  "success": true
}
Expand All
object
operation
object
_id
string
type
string
importerKey
string
ts
string
status
string
valid
boolean
user
string
_updatedAt
string
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

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