Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neo4j Transactions API

Manage explicit transactions with full control over the transaction lifecycle including open, run, commit, and rollback operations.

Neo4j Transactions API is one of 12 APIs that Neo4j publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 9 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.

4 operations 3 paths 9 schemas 1 DELETE3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Server
https://api.neo4j.io/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Neo4j Transactions 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 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Transactions 4

Manage explicit transactions with full control over the transaction lifecycle including open, run, commit, and rollback operations.

POST
/db/{databaseName}/tx
Open a new explicit transaction
openTransaction 1 param body → 201400401404
POST
/db/{databaseName}/tx/{transactionId}
Execute statements in an open transaction
executeInTransaction 2 params body → 200400401404
DELETE
/db/{databaseName}/tx/{transactionId}
Rollback a transaction
rollbackTransaction 2 params → 200401404
POST
/db/{databaseName}/tx/{transactionId}/commit
Commit a transaction
commitTransaction 2 params body → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are QueryStatistics (12 properties), GraphRelationship (5 properties), TransactionResponse (4 properties), CypherStatement (4 properties). Each schema is shown below with its type and property counts.

QueryStatistics
object
Statistics about query execution.
12 properties
GraphRelationship
object
A relationship returned in graph result format.
5 properties
StatementResult
object
Result of a single Cypher statement execution.
3 properties
Neo4jError
object
An error returned by the Neo4j server.
2 properties
CypherStatement
object
A single Cypher statement with optional parameters and result format.
4 properties 1 required
ErrorResponse
object
Response containing one or more errors.
2 properties
TransactionRequest
object
Request body for executing Cypher statements within a transaction.
1 property
TransactionResponse
object
Response from a transaction operation.
4 properties
GraphNode
object
A node returned in graph result format.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neo4j-transactions-api-openapi.yml Raw ↑

Other APIs Neo4j publishes across the network.

Neo4j Query API
Neo4j GraphQL Library
Neo4j Bolt Protocol
Neo4j Python Driver
Neo4j Java Driver
Neo4j JavaScript Driver
Neo4j Authentication API
Neo4j Discovery API
Neo4j Instances API
Neo4j Snapshots API
Neo4j Tenants API