Using

Deletes a document and its index entries. Supports conditional delete via `If-Match: "<etag>"`; a failed precondition answers 412 with the current `ETag`.

applies to v0.5.1

DELETE

/store-api/json/{domain}/documents/{key}

const url = 'https://example.com/store-api/json/example/documents/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/store-api/json/example/documents/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

domain

required

string

JSON domain

key

required

string

Document key

Header Parameters

If-Match

string | null

Opaque ETag from a prior read: delete only if it is still the document’s current version, else 412

If-None-Match

string | null

Only * is supported: 412 if the document exists. Evaluated after If-Match

Responses

204

Document deleted

400

Invalid key, or invalid If-Match or If-None-Match header

text/plain

string

404

Document or domain not found

text/plain

string

410

Domain is being deleted

text/plain

string

412

If-Match or If-None-Match does not hold (version mismatch, missing document, or document exists); nothing was deleted

text/plain

string

Headers

ETag

string

ETag of the document’s current version; absent when the document does not exist

428

The domain requires conditional writes and neither If-Match nor If-None-Match is set

text/plain

string

Headers

Cache-Control

string

No-store

503

JSON engine disabled

text/plain

string

507

Insufficient Storage — disk space or memory runs short; the write was not applied. Reads go on; retry after the seconds in Retry-After.

text/plain

string

Headers

Retry-After

integer