tables

Delete a table

Delete a table. By default, documents in the table are moved to the default table. Set cascade=true in the request body to delete all documents in the table.

delete/v1/tables/{id}

Request

Base URL
https://your-reasondb-host
Auth
- API key in header X-Api-Key
- or none
TypeScript
https://skmtc.dev/brainfish-ai/apis/reasondb-api/docs/v1/tables/:id/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Example:tbl_abc123

Table ID

Request body

cascadeboolean

If true, delete all documents in the table. If false, move them to default table.

Response

Table deleted

deletedboolean

idstring

cascadeboolean

Example response

{
  "deleted": true,
  "id": "tbl_abc123"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.