Batch delete multiple assets

post

{protocol}://{base-url}/integration/v2/asset/{asset_type_name}/batch_delete/

Start a job to delete multiple assets of the same type in a single request.
Accepts a list of asset IDs and queues them for asynchronous deletion.
Deletion is recursive — deleting a schema will also delete all its child tables and columns.

Path Params

asset_type_name

string

required

The name of the asset type.

Body Params

ids

array

required

List of asset IDs to delete. Use integer IDs for schema, table, attribute, file_attribute, and BI types.
Use UUID strings for file and directory. Default maximum is 500 IDs per request.
Instance administrators can adjust this limit via alation_conf: alation.asset.batch_delete.max_size

ids*

delete_method

string

enum

The method by which the assets should be deleted. The default depends on the asset type
(soft for RDBMS and BI, hard for filesystem and bi_server). Returns 400 if an unsupported method is requested.
Supported methods by type:

RDBMS (schema, table, attribute): soft, soft_ttl, hard
Filesystem (file, directory, file_attribute): hard only
BI (bi_folder, bi_report, bi_report_column, bi_datasource, bi_datasource_column): soft, soft_ttl, hard. Cascades to children.
BI Server (bi_server): hard only. Removes entire hierarchy.
Catalog/ELT: soft_ttl, hard
Delete methods:
soft: Assets will be marked as deleted but data preserved. Can be restored.
soft_ttl: Assets will be marked as deleted and permanently removed after a TTL period.
hard: Assets will be permanently deleted with no recovery. All downstream data cleaned.

Allowed:

Responses

200The deletion job was successfully queued.

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error