Cloud: API
RavenDB Cloud API provides client libraries that allow you to perform API operations. The API is defined using the OpenAPI 3.0 standard.
Swagger & available clients
You can use Swagger UI to perform the API calls directly from the website or use Swagger JSON to prepare your own API client.
Client libraries are available in the following languages:
API methods overview
The RavenDB Cloud API contains three categories of API methods: Account, Metadata, Products.
| Category | Description |
|---|---|
| Account | Returns Cloud account information - domain name. |
| Metadata | Return information about available instance types, regions and release channels. |
| Products | Allows to manage products - restart a node, download a client certificate, change the instance and disk type, terminate a cluster, add or remove an additional node from the cluster. |
More information about available methods, requests and responses can be found in the Swagger & available clients section.
An API key authenticates at the account level and operates with Account Owner authority — it is not tied to an individual user. Consequently, the Cloud API is not subject to the finer-grained per-product permissions that apply in the portal: any valid API key can invoke any Products method on any product belonging to its account. Restrict access accordingly when issuing API keys.
API Keys expiration
Max expiration period is 12 months and cannot be longer than this period.
RavenDB Cloud does not send reminders about upcoming API key expiration.
You can change the expiration date or extend it for another 12 months.
For more details, please check the Edit API Key section.
API limitations
You cannot create another product via the RavenDB Cloud API if you have three or more products.
Contact support to extend the quota.
The API limits the number of requests per second. For each IP address and each endpoint, the API can accept one request per second.