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.
Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
branch - master
for most enrollments. The file will still be visible on historical views.
See Datasets Core Concepts for details on using branches and transactions.
To delete a File from a specific Branch specify the Branch's name as branchName
. A new delete Transaction
will be created and committed on this branch.
To delete a File using a manually opened Transaction, specify the Transaction's resource identifier
as transactionRid
. The transaction must be of type DELETE
. This is useful for deleting multiple files in a
single transaction. See createTransaction to
open a transaction.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write
.
string
The Resource Identifier (RID) of a Dataset.
string
The path to a File within Foundry. Examples: my-file.txt
, path/to/my-file.jpg
, dataframe.snappy.parquet
.
string
The name of the Branch on which to delete the File. Defaults to master
for most enrollments.
string
The Resource Identifier (RID) of the open delete Transaction on which to delete the File.
boolean
Enables the use of preview functionality.