Error
4xx errors indicate that there is something wrong in the client request. For instance, the state of the resource is incompatible with the requested operation, or maybe the supplied JSON payload doesn’t match the expected schema. 5xx errors point to an unhandled failure in the server. In some cases, the message returned by the server is:
Error
{ "error": "string" }
The value of the string points to the actual cause. For security reasons, 500 errors include only a nonce (UUID) that should be provided to our support team.
Catalogs
Version
Represents a supported Neo4j version.
| Request path | /databases/versions | |
version | String (id) | Version identifier |
description | String (text) | Version description |
Plan
GrapheneDB plans:
- sandbox
- developer
- s1
- s2
- p1
- p2
- p3
- p4
- p5
Regions
The supported EC2 regions (as of API version 1.0) are:
- us-east-1
- us-west-1
- us-west-2
- eu-west-1
- eu-west-2
- eu-west-3
- ap-northeast-1
- ap-southeast-1
- ap-southeast-2
Operation
The same API endpoint can return a sync or async operation, depending on the database size and plan. The “operation” object represents an asynchronous operation.
| Resource path | /operations/{operationId} | |
id | String (uuid) | Operation id |
databaseId | String (uuid) | Database id |
description | String (text) | Operation description |
stopped | Boolean | Is the database stopped? |
createdAt | String (tstamp) | UNIX epoch |
currentState | String (enum) | global operation status: started finished * failed |
events | Array | Collection of events |
Operation Event
state | String (enum) | Event identifier (human-readable). Examples: freezing-volume creating-snapshot copy-snapshot ... |
createdAt | Integer (tstamp) | UNIX epoch |
Database
| Resource path | /databases/{databaseId} | |
id | String (uuid) | Database identifier |
name | String (text) | Database name |
url | String (url) | Access the Neo4j REST API through this endpoint. |
boltURL | String (url) | Endpoint for Bolt, new Neo4j binary protocol. Available as of Neo4j 3.0 |
webAdminURL | String | Neo4j browser URL. Use Basic Auth with the same credentials as above. This is a REST endpoint. |
metricsURL | String (url, optional) | |
createdAt | String (timestamp) | db creation date, in ISO-8601 |
version | String (text) | Full description of the installed Neo4j version. |
currentSize | Integer (long) | Database size in bytes |
plugins | Array (object) | Installed extensions |
maxSize | Integer (long) | Maximum database size in bytes, depending on the plan. |
plan | Object | Plan object |
awsRegion | String | EC2 region identifier |
counters | Object (optional) | Current number of nodes and relationships. |
cluster | Object (optional) | Information about the cluster, in case the instance is a member. |
Plugin object
id | String(uuid) | Plugin UUID |
name | String | Plugin name |
enabled | Boolean | Is it a managed extension? |
kind | String(enum, optional) | Extension type: storedprocedure extension |
createdAt | String(date) | ISO-8601 date with creation timestamp |
Plan object
type | String(enum) | Plan type (see corresponding section) |
limits | Object | Plan limits |
Limits object
Nodes | Integer(long) | Max no. of nodes in this plan |
Relationships | Integer(long) | Max no. of relationships in this plan |
Counters object
Nodes | Integer(long) | Current no. of nodes |
Relationships | Integer(long) | Current no. of relationships |
Cluster object
masterURL | String(url) | URL of the master node |
nodes | Array (serverId) | Array of nodes |
ServerId object
serverId | Integer | Node identifier |
Backup
| Resource path | /databases/{databaseId}/backups/{backupId} | |
id | String(uuid) | Backup identifier |
state | String(enum) | Backup status: done working |
origin | String(enum) | Backup origin: scheduled manual * automatic |
timestamp | String(date) | ISO-8601 timestamp of the backup termination |
size | Integer(long) | Backup size in bytes |
duration | Integer(long) | Backup duration in seconds |
packageURL | String(UrlPath) | Path to append to the API root to produce a downloadable link with the package (graph.tar.gz) |
downloadable | Boolean | Can the user download the backup package? |
Backup Schedule
| Resource path | /databases/{databaseId}/backups/schedule | |
time | String(time) | H:mm:SS |
timezone | String(enum) | Always set to UTC |
frequency | String(enum) | Always set to “daily” |
Backup Package
| Resource path | /databases/{databaseId}/backups/{backupId}/package | |
backupUrl | String(url) | Secure one-time URL pointing to a volatile S3 bucket. |
Database Export
| Resource path | /databases/{databaseId}/export | |
url | String(url) | Secure one-time URL pointing to a volatile S3 bucket. |
size | Integer | Export file size (graphdb.zip) |