HomeSupport
Sign upLog in

API Reference

This API is organized around REST, which means that:

  • Resources can be accessed in a stateless, predictable manner.
  • Each resource is identified by a URL.
    • Entities are identified by a UUID
      • /databases/822b16bb0c0d4631ae30719cab74c352
    • Collections of entities can be obtained by not specifying a UUID:
      • /databases
    • Nested subresources are used:
      • /databases/822b16bb0c0d4631ae30719cab74c352/restart
      • /databases/822b16bb0c0d4631ae30719cab74c352/backups/latest
  • The entities and collections handled by this API can be obtained using standard HTTP/1.1 methods.
    • POST creates a new entity.
    • GET reads an entity or collection.
    • PUT updates an entity or executes a command on it.
    • DELETE deletes an entity.
  • The standard encoding for all requests and responses is JSON
  • The accepted charset for all communications is UTF-8

📘

All dates are expressed in compliance with RFC 7231

  • Sun, 06 Nov 1994 08:49:37 GMT

Async Operations

Depending on the database characteristics (size, instance type), some actions might take longer than others to complete. If the action is a costly one (eg. create a large instance, restart a db), the API will return a 202 Accepted together with an operation id. For immediate actions, the API returns a 2xx code.

User Files

In some actions the user will be required to provide a valid file (eg. import a backup). In these cases, the user must provide an URL to a AWS S3 bucket. The file must be given all the required permissions so that our infrastructure can access it. In most cases, a random UUID and a public bucket will be enough.

Backup Support

Some operations are only available starting from Standard plans:

  • Scheduled daily backups
  • Manual backups (snapshots)
    All plans include an export option which will generate a downloadable secure link to S3. The import can be applied by uploading the exported file to a valid S3 bucket (see above).

📘

Payment Method

Please make sure you have entered a valid payment method in GrapheneDB’s admin interface. Otherwise, the database creation operations will fail.