Get an evidence bundle

GET/v1/trust/evidence-exports/{id}

Get an evidence bundle.

One evidence bundle: its status, period, and once READY its SHA-256, size, signing key id, expiry and download path. Poll this after creating a bundle.

Requires an organization owner or admin. Errors: 403 for a caller who is not an organization owner or admin; 404 when the organization has no bundle with this id.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

idstring<uuid>required
the evidence bundle id (UUID)

Query parameters

organizationstringrequired
the organization slug

Responses

200application/json

idstring<uuid>
The bundle id (UUID).
organizationstring
The organization slug.
statusenum<string>
Where the bundle is in its life. PENDING: accepted, not started. RUNNING: being built. READY: built and signed, downloadable until expires_at. FAILED: could not be built; error says why. EXPIRED: past its retention, the zip has been deleted.
One of "PENDING", "RUNNING", "READY", "FAILED", "EXPIRED"
start_timestring<date-time>
Start of the period the bundle covers (ISO 8601 date-time).
end_timestring<date-time>
End of the period the bundle covers (ISO 8601 date-time).
errorstring
Why the bundle could not be built; FAILED only.
file_namestring
The zip's file name, evidence-{organization}-{start date}-{end date}.zip (dates in UTC).
sha256string
SHA-256 of the zip file, hex; set once READY.
bytesinteger<int64>
Size of the zip file in bytes; set once READY.
key_idstring
Id of the key that signed the bundle; set once READY. The public key is at GET /v1/public/trust/evidence-signing-key.
regionstring
The AWS region that built the bundle; set once READY.
created_bystring
Who started the export: the user id, or api-key:{key id} for a platform API key.
created_atstring<date-time>
When the export was requested (ISO 8601 date-time).
completed_atstring<date-time>
When the bundle was built (ISO 8601 date-time); absent until then.
expires_atstring<date-time>
When the zip is deleted and the bundle becomes EXPIRED (ISO 8601 date-time), 30 days after it was built; absent until READY.
download_pathstring
Path to download the zip, relative to the API base URL; READY only.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.