Hanzo
OpenapiReference

Lists every set this plane publishes, with its version and how fresh it is.

Lists every set this plane publishes, with its version and how fresh it is.

GET /v1/reference

Addresshttps://api.hanzo.ai/v1/reference
MethodGET
OperationriskReferenceSets
AuthAuthorization: Bearer $HANZO_API_KEY

Lists every set this plane publishes, with its version and how fresh it is.

Read the Stale and Refused lists first: they are the two ways this plane can be quietly wrong, and they are reported rather than inferred. A set in Refused answers nothing — it has never loaded, it is held by another component, or it names a source we hold no licence for.

Request

GET /v1/reference takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200ReferenceSetsOutok

200 body — 24 fields.

FieldInTypeAlwaysDescription
refusedbodystring[]Refused names the sets that cannot be consulted at all.
setsbodyReferenceSet[]Sets is the whole catalog, in a stable order.
sets[].agebodystringAge is how long ago that was.
sets[].asOfbodystringAsOf is when the OLDEST contributing publisher was current, RFC 3339.
sets[].keysbodyintegerKeys is how many members the baseline carries.
sets[].kindbodystringKind is how the baseline comes to exist: fetch (downloaded from a publisher), local (computed here), attest (held by the component that screens against it,…
sets[].matchbodystringMatch is how a key is tested: exact, domain, net, digits, pattern or range.
sets[].maxAgebodystringMaxAge is how old this set may be before it is stale.
sets[].overridesbodyintegerOverrides is how many entries YOUR org has laid over this baseline.
sets[].refusalbodystringRefusal names why the set cannot be relied on, when it cannot: never loaded, held elsewhere, or a licence we do not hold.
sets[].setbodystringSet is the name this set is addressed by.
sets[].sourcesbodyReferenceSource[]Sources is each contributing publisher, its licence and its own freshness.
sets[].sources[].asOfbodystringAsOf is when this publisher was current, RFC 3339.
sets[].sources[].basisbodystringBasis is the KIND of permission this publisher's data reaches you under: licence (an explicit grant), registry (the registry of record publishing for anyone to…
sets[].sources[].keysbodyintegerKeys is how many members this publisher contributed.
sets[].sources[].originbodystringOrigin is exactly where it was taken from, so it can be taken again.
sets[].sources[].refusalbodystringRefusal is why this publisher's last take failed, if it did.
sets[].sources[].sourcebodystringSource is the publisher.
sets[].sources[].termsbodystringTerms is the CITATION that basis points at — the licence identifier, the registry, or the operator publication.
sets[].sources[].versionbodystringVersion is the content digest of what this publisher last supplied.
sets[].stalebodybooleanStale is whether it is past that bound.
sets[].versionbodystringVersion is the exact baseline consulted — every contributing publisher and its content digest.
sets[].whatbodystringWhat the set holds, in one sentence.
stalebodystring[]Stale names the sets past their freshness bound — the list to alarm on.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Reference API · All Hanzo APIs · Interactive reference

How is this guide?

On this page