## Archive a dataset

`datasets.archive(strdataset_id)  -> DatasetArchiveResponse`

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

### Parameters

- `dataset_id: str`

### Returns

- `class DatasetArchiveResponse: …`

  - `id: str`

  - `deleted: bool`

  - `object: Optional[Literal["dataset"]]`

    - `"dataset"`

### Example

```python
import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
response = client.datasets.archive(
    "dataset_id",
)
print(response.id)
```

#### Response

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