---
title: "Truncate collection"
method: PUT
path: "/_fabric/{fabric}/_api/collection/{collection-name}/truncate"
tags: ["Collections"]
---

# Truncate collection

`PUT /_fabric/{fabric}/_api/collection/{collection-name}/truncate`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/collection/:collection-name/truncate/put.ts> (a function with typed inputs; its response is checked against the schema)

Remove all documents from the collection but leaves the indexes intact.

## Path parameters

- `fabric` string, string, required
- `collection-name` string, string, required

## Response `200`

Successfully removed all the documents.

- ApiCollectionGetCollectionNameHttpExamplesRc200
  - `code` integer: HTTP response code.
  - `error` boolean: Flag if there is an error in response. *False* for this response.
  - `id` string: Id of the collection.
  - `name` string: Name of the collection.
  - `status` number: Status of the collection. - 1: new born collection - 2: unloaded - 3: loaded - 4: in the process of being unloaded - 5: deleted - 6: loading - Every other status indicates a corrupted collection.
  - `type` number: Type of the collection. - 2: document collection (normal case) - 3: edges collection
  - `collectionModel` string: Type of collection model. - *DOC*: document model - *KV*: key/value model - *DYNAMO*: dynamo model
  - `isSpot` boolean: *True* if collection is a spot collection.
  - `isLocal` boolean: *True* if collection is a local collection.
  - `hasStream` boolean: *True* if collection has a stream.
  - `waitForSync` boolean: *True* if all data must be synced to storage before operation returns.
  - `isSystem` boolean: *True* if collection is a system collection.
  - `globallyUniqueId` string: Collection's global unique Id.
  - `searchEnabled` boolean: *True* if collection is searchable.
  - `blobs` boolean: *True* if collection is a blob-only collection.

## Other responses

- `400`: Failed due to missing or malformed data. Verify that all parameters are complete.
- `404`: Failed to find specified collection.

---

[API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)