ArangoDB v3.8 reached End of Life (EOL) and is no longer supported.

This documentation is outdated. Please see the most recent version at

The ArangoGraph API

The ArangoGraph Insights Platform, comes with its own API. This API enables you to control all resources inside ArangoGraph in a scriptable manner. Typical use cases are spinning up ArangoGraph deployments during continuous integration and infrastructure as code.

The ArangoGraph API…

  • is a well-specified API that uses Protocol Buffers as interface definition and gRPC as underlying protocol.

  • allows for automatic generation of clients for a large list of languages. A Go client is available out of the box.

  • uses API keys for authentication. API keys impersonate a user and inherit the permissions of that user.

  • is also available as a command-line tool called oasisctl.

  • is also available as a Terraform plugin. This plugin makes integration of ArangoGraph in infrastructure as code projects very simple. To learn more, refer to the plugin documentation.

Also see: