API Reference

Execute File Import

POST/api/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Executes the FileImport, which runs asynchronously as a Foundry Build. The returned BuildRid can be used to check the status via the Orchestration API.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-file-import-execute.

Path parameters

connectionRid

string

The Resource Identifier (RID) of a Connection (also known as a source).

fileImportRid

string

The Resource Identifier (RID) of a FileImport (also known as a batch sync).

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

BuildRid

string

The RID of a build.

Examples

Request

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports/ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158/execute?preview=true"

Error responses

Error Name
`ExecuteFileImportPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not execute the FileImport.
	Parameters	`fileImportRid, connectionRid`

See Errors for a general overview of errors in the platform.