POST /data/v2/projects/{projectToken}/imports/{import_id}/start
/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.
Servers
- https://api.exponea.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectToken |
String | Yes |
Default value: "12345678-1234-1234-1234-123456789abc" |
import_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
authorization |
String | Yes |
Default value: "Basic <APIKeyID/APISecret>" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
test_connection |
Boolean | No |
Default value: true |
path |
String | No |
Default value: "URL" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.