Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Delete File Import

DELETE/api/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}

Delete the FileImport with the specified RID. Deleting the file import does not delete the destination dataset but the dataset will no longer be updated by this import.

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

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).

Examples

Request

Copied!
1 2 3 curl -X DELETE \ \t-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"

Error responses

Error Name
DeleteFileImportPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not delete the FileImport.
ParametersfileImportRid, connectionRid
FileImportNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given FileImport could not be found.
ParametersfileImportRid, connectionRid