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

This documentation is outdated. Please see the most recent version here: Latest Docs

ArangoDB Oasis API

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

The ArangoDB Oasis 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 commandline tool called oasisctl.

  • is also available as a Terraform plugin. This plugin makes integration of Oasis in infrastructure as code projects very simple. Note that the terraform plugin is still in prerelease, so its interface can still change.

Also see: