genroc

docs / Reference / REST API

API errors

The classification every error reply carries, and the status each renders as.

Every error reply carries a code. It is the part a client should branch on: the HTTP status is a rendering of it, and TCP and UDS callers never see a status line at all.

CodeStatusMeans
invalid400the request is malformed or unacceptable — retrying it unchanged will never succeed
unauthenticated401no identity was established
forbidden403the caller is known and lacks the permission this action needs
not_found404the definition, instance, channel or task named does not exist
conflict409the request is well-formed and the target exists, but its current state forbids the operation; the identical request may succeed later
internal500anything unclassified, which is a server fault until proven otherwise
unsupported501the endpoint exists, but this server is not configured to serve it
unavailable503this server cannot serve requests right now, its database being unreachable — route elsewhere and retry