Soft-delete a vault

DELETE

/vaults/{id}

const url = 'https://api.engram.page/vaults/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://api.engram.page/vaults/example \
  --header 'Authorization: Bearer <token>'

Soft-deletes the vault, keeping it restorable for 30 days before it is permanently purged. Returns 404 when no such vault exists.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Vault UUID

Responses

200

Soft-deleted (restorable for 30 days)

application/json

VaultDeleted

object

deleted

required

boolean

required

string format: uuid

Example

{
  "deleted": true
}

403

Vault only readable by the credential: this needs write access to the vault

application/json

MessageError

object

error

required

string

Example

{
  "error": "not found"
}

404

No such vault, or one the credential cannot reach (the two look the same)

application/json

MessageError

object

error

required

string

Example

{
  "error": "not found"
}