DOCUMENTATIONv2

GET

Protected data vault

List protected objects

/api/v2/data-vault/objects

AUTHENTICATIONBearer token · vault:readAUTHORITATIVE OWNERvault-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List 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.

WHEN THIS CALL IS USEFUL

Start private Data Vault navigation here to discover the authenticated workspace's top-level protected objects before selecting a stable object identifier.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover protected objects.
Supports private object discovery and evidence selection while keeping content access, keys, grants, storage topology, and retention authority outside the listing contract.

ISOLATION + AUTHORITY

Tenant, workspace, object, directory, version, content, encryption key, storage location, retention policy, access grant, evidence commitment, and download authority remain distinct. Object discovery or integrity metadata does not reveal protected content, create a grant, authorize decryption, or prove an external business outcome.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the authenticated workspace, opaque object identifier, object type, integrity requirement, and any separately authorized content-access or retention workflow.

WHAT TO DO NEXT

Follow the returned opaque object identifier to its detail or immediate-child operation without constructing storage paths or assuming recursive access.
Resolve any separate grant, version, retention, decryption, or download contract before requesting protected content or using the commitment externally.

AGENT GUIDANCE

Use protected objects only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Treat object existence, metadata readiness, directory membership, version, integrity commitment, access grant, decryption, download, retention, and external acceptance as separate lifecycle facts.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the vault:read scope.EXAMPLEBearer hc_live_…

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

401invalid_credentialsThe bearer credential is missing, expired, or invalid.

403insufficient_scopeThe principal lacks owner-scoped Data Vault read authority.

404data_vault_object_not_foundThe object does not exist in the authenticated workspace.

422invalid_data_vault_objectThe object identifier is invalid.

422data_vault_request_rejectedOwner or workspace policy rejected the Data Vault request.

503data_vault_unavailableAuthoritative Data Vault metadata is temporarily unavailable.

RESPONSES

Status and payload examples

200Top-level encrypted objects in the authenticated workspace with minimized owner-use metadata, readiness, opaque content roots, and commitment-only evidence.Read completed · JSON RESPONSE+

{
  "items": [
    {
      "object_id": "f7a9ac7f9fbc4cba8d9cd95081288d63",
      "name": "quarterly-reserve-evidence.json",
      "kind": "JSON",
      "size_bytes": 18432,
      "is_directory": false,
      "parent_object_id": null,
      "encrypted_content_root": "bafybeihybridchainencryptedcontentroot",
      "shard_count": 4,
      "storage_readiness": "READY",
      "favorite": true,
      "shared": false,
      "recycled": false,
      "created_at": "2026-09-01T18:30:00Z",
      "evidence": {
        "event_id": "64ab8439c82843ef91a0b83ec970927c",
        "event_commitment": "sha256:dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
        "anchor_state": "PENDING",
        "event_type": "FILE_UPLOADED",
        "recorded_at": "2026-09-01T18:30:01Z"
      }
    }
  ],
  "total": 1
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then follow the returned opaque object identifier to its detail or immediate-child operation without constructing storage paths or assuming recursive access.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh vault metadata, classification, object commitment, retention version, grant state, and audit record; never infer access to encrypted payload bytes from metadata.

401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for owner-scoped vault metadata, data classifications, commitments, retention state, grants, and audit evidence.
ESCALATE WHEN: Escalate when ownership, grant, retention, classification, or commitment evidence cannot be reconciled without disclosing protected data.

403The credential lacks explicitly provisioned vault:read authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks explicitly provisioned vault:read authority."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for owner-scoped vault metadata, data classifications, commitments, retention state, grants, and audit evidence.
ESCALATE WHEN: Escalate when ownership, grant, retention, classification, or commitment evidence cannot be reconciled without disclosing protected data.

503The authoritative Core Data Vault metadata projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "data_vault_unavailable",
  "message": "The authoritative Core Data Vault metadata projection is unavailable."
}

INTEGRATION DECISIONdata_vault_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh vault metadata, classification, object commitment, retention version, grant state, and audit record; never infer access to encrypted payload bytes from metadata.
ESCALATE WHEN: Escalate when ownership, grant, retention, classification, or commitment evidence cannot be reconciled without disclosing protected data.

OPERATIONAL NOTES

Security and lifecycle guarantees

Use this collection for a private owner dashboard, to choose an object for a later detail read, or to reconcile stored-object evidence. It is not recursive and accepts no vault, owner, directory, filter, pagination, or request-body selector.
The active workspace in the bearer determines the vault. The API never accepts a caller-supplied vault ID, and Core applies the same workspace at the authoritative query.
encrypted_content_root is an opaque locator for encrypted stored content. It is not a URL, key, download ticket, possession proof, or permission to disclose cleartext.
The response excludes vault IDs, raw upload and IPFS metadata, shard records and node topology, encryption/decryption material, and content. Treat names and content roots as private; responses are no-store.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗