vault

Delete one item from a site's vault

Delete one item from the site's vault, with its passages (no search reaches them from then on) and, for a file, its original. It cannot be undone: your human would have to add it again, so delete only what they asked you to. It asks for confirmation: call it with dry_run: true to see what it would delete, then with confirm: true. An item that is not there, because it is already deleted or never was this site's, is NOT_FOUND, and nothing is deleted.

delete/v1/sites/{site}/vault/items/{item_id}

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/vault/items/{item_id}
  • Auth: HTTP bearer

Path parameters

sitestring required

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

item_idstring required

A vault item id (vit_…), from vault_list.

Query parameters

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Delete one item from a site's vault

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

site_idstring required

The site's canonical id.

item_idstring required
deletedtrue required

Changes

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