/data/v2/projects/{projectToken}/imports/{import_id}/start
Trigger the run of an existing import.
The following types of imports can be triggered: URL, Filestorage (GCS, SFTP), Database, Bloomreach Engagement.
If it is a URL or a Filestorage (GCS, SFTP), it is possible to override its original path/URL. When overridden, it does not modify the import definition, the path is overridden just for this run of the import.
Please note that the import must be running (repeated). One-time imports are not supported. The import must also be at least in a state of draft to be able to trigger. This means you need to already have SFTP integration configured and working.
Definition
Authorization
In this API call you must use the following authorization access and permissions:
| Available access type | Permissions needed |
|---|---|
| Private access | Imports > Allow trigger imports |
Read more about:
Path parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| projectToken | string | The ID of your project. | Required |
| import_id | string | The ID of an existing import in your project. | Required |
Body Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| path | string | URL, GCS, or SFTP path to override. Note that this does not modify the import definition, the path is overridden just for this run of the import. | No |
| test_connection | boolean | Allows you to skip the import source connection checking and thus avoid timeouts. Note that imports can fail to execute later because source was not checked. Default = true. | No |
Header
| Parameter | Type | Description | Required |
|---|---|---|---|
| authorization | string | Used for authentication. Read more in the Authentication section. | Required |
| content-type | string | application/json Note that if you are sending this request without a body, the header must not contain content-type: application/json. Including it will result in Error 400 | Required if body is not empty. |
Limitations
- It is not possible to trigger Copy & Paste and Upload imports from this route.
- The import must be running (repeated). One-time imports are not supported.