Neo4j Instances API
Manage AuraDB cloud database instances including provisioning, configuration, lifecycle operations such as pause and resume, and deletion.
Neo4j Instances API is one of 12 APIs that Neo4j publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Instances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 8 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.neo4j.io/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Neo4j Instances API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— OAuth2 bearer token obtained from the /oauth/token endpoint using client credentials. Tokens expire after one hour.
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Manage AuraDB cloud database instances including provisioning, configuration, lifecycle operations such as pause and resume, and deletion.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Instance (12 properties), CreateInstanceRequest (7 properties), InstanceCreated (7 properties), UpdateInstanceRequest (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Neo4j 11
Other APIs Neo4j publishes across the network.