|
1 | 1 | :description: The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests.
|
2 | 2 |
|
| 3 | + |
3 | 4 | = Introduction
|
4 | 5 |
|
5 | 6 | [WARNING]
|
6 | 7 | ====
|
7 |
| -The HTTP API is currently not available on link:{neo4j-docs-base-uri}/aura[Neo4j Aura]. |
| 8 | +The HTTP API is not available on <<Aura>>. |
| 9 | +Use the link:{neo4j-docs-base-uri}/query-api/current/[Query API] instead. |
8 | 10 | ====
|
9 | 11 |
|
10 | 12 | The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests.
|
11 | 13 |
|
12 | 14 | The main use case of the HTTP API is for developing client applications in languages for which there is no supported library.
|
13 | 15 | If there exists an official library (driver) for the language you are using, consider using that instead -- see link:{neo4j-docs-base-uri}/create-applications/[Create applications].
|
14 | 16 |
|
| 17 | +By default, the API uses port 7474 for HTTP and port 7473 for HTTPS. |
| 18 | + |
15 | 19 | This guide assumes that you have:
|
16 | 20 |
|
17 |
| -- a running Neo4j instance -- if not, check out how to link:{neo4j-docs-base-uri}/operations-manual/current/installation/[install Neo4j] |
18 |
| -- some familiarity with <<Cypher>> -- if you need a hand, check out link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Getting started -> Cypher]. |
| 21 | +- A running instance of Neo4j -- If you don't have one, link:https://neo4j.com/docs/operations-manual/current/installation/[install Neo4j locally] or sign up for an link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura cloud instance]. |
| 22 | +- Some familiarity with <<Cypher>> -- If you are new to it, check out link:https://neo4j.com/docs/getting-started/cypher-intro/[Getting started -> Cypher]. |
19 | 23 |
|
20 | 24 | To execute queries through the HTTP API, you may use either:
|
21 | 25 |
|
22 | 26 | - xref:query.adoc[Implicit transactions] -- you just submit queries, the API takes care of the transaction handling for you
|
23 | 27 | - xref:transactions.adoc[Explicit transactions] -- you control the lifecycle of the transaction (open, commit, rollback), within which you can execute queries.
|
24 | 28 |
|
25 |
| -[TIP] |
26 |
| -By default, the HTTP API uses port 7474 for HTTP and port 7473 for HTTPS. |
27 |
| - |
28 | 29 | [NOTE]
|
29 | 30 | As of Neo4j 5.17, the HTTP API supports HTTP/2 as well as HTTP/1.1, unless either is explicitly disabled in the server configuration setting link:https://neo4j.com/docs/operations-manual/5/configuration/configuration-settings/#config_server.http_enabled_transports[`server.http_enabled_transports`].
|
30 | 31 | It's up to the client to initiate a connection with the preferred protocol.
|
|
0 commit comments