Errors

Census answers errors with an RFC 7807 problem body. type identifies the case, so a consumer can tell an incomplete inventory from a missing branch or a cache outage without reading the text.

{
  "type": "inventory-incomplete",
  "title": "Inventory incomplete",
  "status": 409,
  "detail": "the inventory is incomplete and complete results were required",
  "causes": [ { "cause": "no_snapshot", "contribution": "netbox" } ]
}

Error cases

Status	type	When	Extra keys
400	invalid-query	An unknown parameter, a filter or sort on an undeclared field, a value that does not parse as the field's type, an undeclared location, a cursor Census did not issue, or a limit out of range.	parameter
404	inventory-not-found	No inventory has this id.	inventory
404	entity-not-found	The inventory has no entity with this HFID.	hfid
404	branch-not-found	No source of the inventory has this branch.	branch
409	inventory-incomplete	require_complete=true and the inventory is incomplete.	causes
503	inventory-rebuilding	Census is recomputing the inventory after a configuration change. Retry later.	inventory
503	branch-unavailable	A source that supports branches cannot be reached, and Census does not hold the branch view yet.	contribution, error
503	cache-unavailable	Census cannot reach Memgraph.

detail gives a sentence that names the value at fault, for example filter.ports: "many" is not a number.