SPsparkvault
vaults

Schedule vault deletion

Changed on

A company administrator or owner schedules permanent deletion seven days ahead. The vault stays visible, but immediately refuses content access, unsealing, uploads, downloads and shared links, including existing access tokens. Other active company administrators are emailed. One whose address the mail service declines (a suppressed address) is not, and the deletion does not wait for that notice: the answer names each one (deletion_notice_unreached), as the vault's read does to a company administrator, and until the deadline the notice is tried again at the address each holds then. An administrator can cancel the specific schedule before deletion_scheduled_for through POST /vaults/{id}/deletion/cancel. Repeating this request returns the existing schedule without extending its deadline. After the deadline, irreversible background cleanup removes the vault, ingots, folders, keys, sessions, links and audit trail. A vault the platform keeps for a product (the Messaging vault) is refused: it goes only with its account. The vault a help desk keeps its requests in is refused while the desk is active, and while any of its requests is under legal hold.

delete/vaults/{id}

Request

Path parameters

idstring required

The vault to delete.

Headers

X-Vault-Deletion-Mode'schedule' required

Must be schedule. Confirms that the client retains the vault and its saved keys during the cancellation window; older clients expecting immediate deletion are refused before any change.

X-Confirm-Name-B64string required

The vault name as standard base64 of its UTF-8 bytes, so any name travels in a header. It must decode to the vault name exactly (case-sensitive); a mismatch, or a value that is not base64 of UTF-8, is refused 400 VALIDATION_ERROR.

Response

Deletion is scheduled; a request after permanent cleanup starts returns status deleting.

Changes

  • 97cfadccd0c0Revision changes
    • info

      added the optional property / to the response with the status

  • a9a10e328ba5Revision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status