Documents

Delete a document

DELETE/documents/{id}
documents:writedelete_documentDestructiveIdempotent

Deletes the document, keeping its stored file, and returns 204. A document that is a deal's or team member's image returns 409 conflict: replace or remove the image first. Deleting a document that is already deleted returns 404. Needs write access to the document, else 403 forbidden. It has no dry run. Emits document.deleted after commit; no email. It can't be undone.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

204

The document was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/documents/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"