Authentication

Health and ready do not require a key. Every other call requires a key. Send it as Authorization: Bearer $GRAPHON_ENGINE_API_KEY or as X-API-Key. Issued keys use the prefix gek_.

Key kinds

A cluster key can manage namespaces and keys.

A namespace key can use its actions on one namespace. It cannot see other namespaces.

A collection key can use its actions on the named collections only.

Actions

Actions are read, write, search, and query. write includes read. Search and Query do not include each other.

A missing key returns 401. A key that can see the resource but lacks the action returns 403.

A namespace key receives 404 for another namespace.