HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2

TRUST & DATA · MODULE 24

Data Vault

Navigate minimized owner-scoped protected-object metadata today and design future client-encrypted upload, purpose-bound retrieval, controlled sharing, retention, and erasure workflows without making the gateway a storage owner, key custodian, or cleartext proxy.

BUSINESS CASES

Where this module fits

  • protected document inventory and bounded directory navigation
  • client-encrypted multipart storage
  • purpose- and recipient-bound retrieval
  • controlled sharing and grant revocation
  • retention, recycle, restore, and cryptographic-erasure governance
  • private-to-public evidence reconciliation

PRIMARY CONSUMERS

Who integrates it

  • workspace data owners
  • records and compliance systems
  • document-processing agents
  • evidence and disclosure integrations

PREREQUISITES

What must exist first

  • vault:read for implemented private reads and a separately promoted vault:write contract for mutations
  • an authenticated active workspace derived from the bearer
  • classification, retention, legal-hold, encryption, quota, recipient, and disclosure policy
  • a client-side encryption and key-management boundary outside the gateway
  • caller-owned rules for evidence freshness, storage readiness, ticket handling, and public-anchor finality

RECOMMENDED WORKFLOW

Compose the module safely.

  1. 01

    ingest live OpenAPI and use the bearer-derived workspace root; never submit a vault selector

  2. 02

    list top-level objects, select by stable object identifier, and refresh current minimized detail

  3. 03

    navigate directories one bounded level at a time instead of requesting or inferring a recursive tree

  4. 04

    when promoted, create a bounded client-encrypted upload session and complete it only after every ordered part, digest, content root, and manifest commitment verifies

  5. 05

    when promoted, request a short-lived subject-, purpose-, object-, version-, and audience-bound download ticket after current owner or grant authorization

  6. 06

    when promoted, create, inspect, and revoke typed grants separately from invitations and delivery

  7. 07

    reconcile retention, legal holds, grants, replicas, and key-destruction evidence before recycle, restore, or erasure

  8. 08

    verify private owner state separately from public Explorer anchor and proof projections

MODULE CONTRACTS

Every mapped endpoint

Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.

GETList protected objects/api/v2/data-vault/objectsList the authenticated workspace's top-level encrypted objects with minimized owner-use metadata, storage readiness, opaque content roots, and commitment-only evidence. Keys, shard topology, raw storage metadata, and download authority are excluded.DELETEDelete protected object/api/v2/data-vault/objects/{object_uuid}Planned capability: request policy-governed deletion or cryptographic erasure of an eligible object.GETGet protected object/api/v2/data-vault/objects/{object_uuid}Return minimized metadata and integrity evidence for one object after enforcing ownership at the authoritative storage query. Versions, retention policy, grants, keys, and download authority are not yet published by this contract.GETList directory children/api/v2/data-vault/objects/{object_uuid}/childrenList one owner-scoped directory's immediate children using the same minimized object projection. This is single-level navigation, not a recursive tree, sharing grant, or download capability.POSTCreate download ticket/api/v2/data-vault/objects/{object_uuid}/download-ticketsPlanned capability: issue a short-lived, subject-bound download ticket for an authorized object version.GETList sharing grants/api/v2/data-vault/objects/{object_uuid}/grantsPlanned capability: list active and historical access grants for a protected object.POSTCreate sharing grant/api/v2/data-vault/objects/{object_uuid}/grantsPlanned capability: grant a subject time- and purpose-bounded access to a protected object.POSTRevoke sharing grant/api/v2/data-vault/objects/{object_uuid}/grants/{grant_uuid}/revocationsPlanned capability: revoke an active access grant while retaining its audit record.POSTCreate upload session/api/v2/data-vault/upload-sessionsPlanned capability: create a bounded multipart upload session with content, retention, encryption, and integrity policy.POSTComplete upload/api/v2/data-vault/upload-sessions/{session_uuid}/completionPlanned capability: verify uploaded parts and commit one immutable encrypted object version.POSTGenerate data structure tree/api/v2/quantum/storage/datatreePlanned capability: apply the requested transition to generate data structure tree through the authoritative trust service boundary.POSTDelete file from data vault/api/v2/quantum/storage/deletePlanned capability: apply the requested transition to file from data vault through the authoritative trust service boundary.POSTCreate file download link from datavault/api/v2/quantum/storage/downloadPlanned capability: apply the requested transition to file download link from datavault through the authoritative trust service boundary.POSTToggle favorites for file or folder/api/v2/quantum/storage/favoritePlanned capability: apply the requested transition to toggle favorites for file or folder through the authoritative trust service boundary.POSTRequest file meta data/api/v2/quantum/storage/metadataPlanned capability: apply the requested transition to file meta data through the authoritative trust service boundary.POSTCreate new folder/api/v2/quantum/storage/newfolderPlanned capability: apply the requested transition to new folder through the authoritative trust service boundary.POSTRecycle file in datavault/api/v2/quantum/storage/recyclePlanned capability: apply the requested transition to recycle file in datavault through the authoritative trust service boundary.POSTRename items in datavault/api/v2/quantum/storage/renamePlanned capability: apply the requested transition to rename items in datavault through the authoritative trust service boundary.POSTRestore file from recycle bin/api/v2/quantum/storage/restorePlanned capability: apply the requested transition to restore file from recycle bin through the authoritative trust service boundary.POSTUpload file to data vault/api/v2/quantum/storage/uploadPlanned capability: apply the requested transition to upload file to data vault through the authoritative trust service boundary.GETList compose public vault asset holdings/api/v2/explorer/vault-assets/{uuid}Planned capability: planning marker for the Explorer website's vault-holdings composition. Canonical integrations list assets with owner_vault_uuid, fetch exact asset records when holding-level detail is needed, and optionally join the public vault and vault-history reads by vault UUID.GETGet all vaults/api/v2/explorer/vaultsList all vaults from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETGet vault record/api/v2/explorer/vaults/{uuid}Return vaults uuid from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETGet vault details/api/v2/explorer/vaults/{vault_uuid}Return vault details from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.GETGet vault history/api/v2/explorer/vaults/{vault_uuid}/historyReturn the ordered public record for vault history from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.