Read the directory’s log state

Identify the active log and read the checkpoint and witness state seen by the server.

GET/v1/log

Access: Public; API key optional
Client: Browser fetch supported

Request examples#

cURL

curl -fsS 'https://veil.rip/v1/log'

javascript

const response = await fetch("https://veil.rip/v1/log");
const result = await response.json();

Try the request#

Response#

HTTP 200application/json

origin, size, root, checkpoint, witnesses, quorum, quorumMet, freshness and consistency information. These are the server’s checks.

Field	Type	Meaning
`origin`	`string`	Log origin.
`size`	`integer`	Current tree size.
`root`	`string`	Signed root hash in base64.
`logSignatureOk`	`boolean`	Server check of the log signature.
`rootOk`	`boolean`	Server check of checkpoint consistency.
`quorum`	`integer`	Required witness signatures.
`signed`	`integer`	Valid witness signatures on the current size.
`of`	`integer`	Number of configured witnesses.
`quorumMet`	`boolean`	Whether the current checkpoint meets the quorum.
`witnesses`	`array<object>`	Each row has id, name, size, signedAt (Unix seconds or null), ok, current, error, operator, kind, logo and initials.
`checkpoint`	`string`	Full signed note.
`checkedAt`	`string`	Server check time in ISO 8601 UTC.
`newestCosignatureAt`	`integer \| null`	Newest valid cosignature time in Unix seconds.
`fresh`	`boolean`	Whether the checkpoint is within freshSeconds.
`freshSeconds`	`integer`	Freshness threshold in seconds.
`consistency`	`object`	from, fromRoot, proof, ok, firstUse, behind and error describe comparison with the accepted checkpoint.
`accepted`	`object \| null`	Last accepted size, root and at, plus firstSize and firstAt where its chain began.
`format`	`integer \| optional`	The log’s format when it is not 1: 2 for labels, bodies and the index.
`staffOrg`	`string \| optional`	Format 2: the token of the Veil organisation, the parameter of the index. Absent in format 1 and while the server has no Veil organisation. A browser refuses a format 2 log that does not give it.

Response headers#

Header	Value	Meaning
`Content-Type`	`application/json`	Use the declared media type before choosing a parser.
`Date`	`HTTP date`	Server time. Compare it with your clock when signing requests.
`Retry-After`	`integer seconds, on rate_limited or busy`	Wait at least this long before retrying. Other 429/503 codes do not necessarily include it.

What to verify#

Pin the expected log and witness policy for independent verification. A different log is not an interchangeable history.

Errors#

API errors return an error object. Use error.code for program logic; error.message is English text for people and can change. Response and error guide

HTTP Code Meaning and next step

503

HTTP	Code	Meaning and next step
503	`log_unavailable`	The public log cannot currently be read, verified or used for publication. For reads, keep the result unverified and try later. Before retrying a write, read the card to check whether publication completed.

log_unavailable

The public log cannot currently be read, verified or used for publication.

For reads, keep the result unverified and try later. Before retrying a write, read the card to check whether publication completed.

When using an optional API key

HTTP	Code	Meaning and next step
401	`invalid_api_key`	The bearer credential is malformed, unknown, expired or revoked. Use an active key. To use anonymous public access, remove `Authorization` entirely. Invalid credentials never fall back automatically.
403	`api_key_scope`	The API key lacks read or verify scope, or the endpoint does not accept bearer keys. Use the correct scope. Identity writes and key management still require a device signature.
403	`api_key_suspended`	This API key is suspended. Ask staff to restore it; another key cannot lift an account suspension.
403	`developer_suspended`	The owner’s API account is suspended or the owner card is unavailable. Check the owner account and any staff restriction. Creating another key does not bypass suspension.

Shared request errors

HTTP Code Meaning and next step

429

HTTP	Code	Meaning and next step
429	`rate_limited`	An anonymous, signed-request or API-key allowance was exceeded. Wait at least `Retry-After` seconds. Share a queue and retry budget across your workers.
500	`internal_error`	An unexpected server error occurred. Internal details are not returned. Retry reads with bounded backoff. Check write results before sending a new signed operation.
503	`busy`	The application has reached a temporary concurrency or database limit. Wait `Retry-After` seconds and retry with bounded backoff.

rate_limited

An anonymous, signed-request or API-key allowance was exceeded.

Wait at least Retry-After seconds. Share a queue and retry budget across your workers.

500

internal_error

An unexpected server error occurred. Internal details are not returned.

Retry reads with bounded backoff. Check write results before sending a new signed operation.

503

busy

The application has reached a temporary concurrency or database limit.

Wait Retry-After seconds and retry with bounded backoff.

Read this entry as JSON