Skip to content

Query API for Aura #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025
Merged

Query API for Aura #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/content-nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ Generic Start

* Connecting applications
** xref:connecting-applications/overview.adoc[Drivers and libraries]
** xref:connecting-applications/query-api.adoc[Using Query API]

* Neo4j Connectors
** xref:connectors/spark.adoc[Neo4j Connector for Apache Spark]
Expand Down
15 changes: 15 additions & 0 deletions modules/ROOT/pages/connecting-applications/query-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[[aura-query-api-tutorial]]
= Using the Query API with Aura
:description: Use the Query API with Aura to execute Cypher statements against a Neo4j server through HTTPS requests.

== Introduction

The Query API enables interaction with an Aura database using Cypher via HTTPS.

For more information, see the link:https://neo4j.com/docs/query-api/current/[Query API documentation] but note that:

* For Aura instances, the host follows the format `<databaseID>.databases.neo4j.io`

* The Query API documentation mainly refers to self-managed instances that use port `7474`, whereas Aura supports HTTPS only, which defaults to port `443`

* As HTTPS implies port `443` in the request, you do not need to include the port in the URL.