Archive a dataset

DELETE/v5/datasets/{dataset_id}

Soft-delete a dataset by archiving it; the row is retained and can be restored later.

This sets the dataset’s archived_at timestamp rather than permanently removing it, and cascades the same archival to the dataset’s items and versions. Archiving is not idempotent: if the dataset is already archived the call fails. The dataset can be brought back with the PATCH restore request. The response reports the dataset id with deleted set to true.

Path ParametersExpand Collapse

dataset_id: string

ReturnsExpand Collapse

id: string

deleted: boolean

object: optional "dataset"

Archive a dataset

curl https://api.egp.scale.com/v5/datasets/$DATASET_ID \
    -X DELETE \
    -H "x-api-key: $SGP_API_KEY"

{
  "id": "id",
  "deleted": true,
  "object": "dataset"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "dataset"
}