Key Value

Remove all key-value pairs in a collection

Remove all key-value pairs in a collection.

put/_fabric/{fabric}/_api/kv/{collection}/truncate

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/kv/:collection/truncate/put.ts
A function with typed inputs. Its response is checked against the schema.

fabricstring string required

The name of the fabric.

collectionstring string required

The name of the key-value collection.

groupIDstring string

Truncate the key-value pairs belonging to this group ID.

Successfully removed all key-value entries.

codeinteger

HTTP response code.

errorboolean required

Flag if there is an error in response. False for this response.

namestring

It shows name of the collection.

{
  "code": 200,
  "name": "testCollection"
}

No recorded changes to this operation across all 1 revision of this API.