Neo4j
Run Cypher on Neo4j and get rows, use transactions and merge nodes and relationships from rows. Typical uses: load a graph from tables, query relationships for a report.
neo4j pingneo4j infoneo4j merge_nodesneo4j merge_nodesneo4j merge_relsneo4j queryneo4j queryneo4j executeneo4j executeneo4j transactionneo4j schemaneo4j requestneo4j request
neo4j ping <config>
Description
The version and edition of the server from its discovery document (no authentication): {version, edition}
The version and edition of the server from its discovery document (no authentication): {version, edition}
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
admin
neo4j ping "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}"
mentdb
{"version": "5.26.0", "edition": "community"}
neo4j info <config>
Description
The version and edition of the server, the API used, and a test of the authentication: {version, edition, query_api, database, connected, api}
The version and edition of the server, the API used, and a test of the authentication: {version, edition, query_api, database, connected, api}
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
admin
neo4j info "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}"
mentdb
{"version": "5.26.0", "edition": "community", "query_api": true, "database": "neo4j", "connected": true, "api": "query"}
neo4j merge_nodes <config> <label> <key> <json_rows>
Description
Create or update nodes from rows: MERGE on the key, then all the non-null fields of the row as properties (a null field keeps the existing property). Returns the counters with rows and batches
Create or update nodes from rows: MERGE on the key, then all the non-null fields of the row as properties (a null field keeps the existing property). Returns the counters with rows and batches
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
label: The label - String - required
key: The field that identifies a node (must be in each row) - String - required
json_rows: The rows - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
label: The label - String - required
key: The field that identifies a node (must be in each row) - String - required
json_rows: The rows - String - required
admin
neo4j merge_nodes "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "Person" "id" "[{\"id\": 1, \"name\": \"Zoé\", \"age\": 31}, {\"id\": 2, \"name\": \"Bob\", \"age\": 45}, {\"id\": 3, \"name\": \"Ana\"}]"
mentdb
{"rows": 3, "batches": 1, "nodes_created": 3, "nodes_deleted": 0, "relationships_created": 0, "relationships_deleted": 0, "properties_set": 11, "labels_added": 3, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}
neo4j merge_nodes <config> <label> <key> <json_rows> <json_options>
Description
Merge nodes with options: batch_size (1000, rows per transaction), on_create_only (true: an existing node is not changed)
Merge nodes with options: batch_size (1000, rows per transaction), on_create_only (true: an existing node is not changed)
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
label: The label - String - required
key: The key field - String - required
json_rows: The rows - String - required
json_options: The options - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
label: The label - String - required
key: The key field - String - required
json_rows: The rows - String - required
json_options: The options - String - required
admin
neo4j merge_nodes "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "Company" "id" "[{\"id\": \"acme\", \"name\": \"ACME\", \"city\": \"Saint-Denis\"}]" "{\"batch_size\": 500}"
mentdb
{"rows": 1, "batches": 1, "nodes_created": 1, "nodes_deleted": 0, "relationships_created": 0, "relationships_deleted": 0, "properties_set": 4, "labels_added": 1, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}
neo4j merge_rels <config> <json_spec> <json_rows>
Description
Create relationships from rows: spec {type, from: {label, key, field}, to: {label, key, field}, properties (the fields to copy; default: all but the two fields), create_nodes (false: rows whose nodes do not exist are skipped), batch_size (1000)}. Returns the counters with rows and batches
Create relationships from rows: spec {type, from: {label, key, field}, to: {label, key, field}, properties (the fields to copy; default: all but the two fields), create_nodes (false: rows whose nodes do not exist are skipped), batch_size (1000)}. Returns the counters with rows and batches
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
json_spec: The relationship - String - required
json_rows: The rows - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
json_spec: The relationship - String - required
json_rows: The rows - String - required
admin
neo4j merge_rels "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "{\"type\": \"WORKS_AT\", \"from\": {\"label\": \"Person\", \"key\": \"id\", \"field\": \"person\"}, \"to\": {\"label\": \"Company\", \"key\": \"id\", \"field\": \"company\"}}" "[{\"person\": 1, \"company\": \"acme\", \"since\": 2020}, {\"person\": 2, \"company\": \"acme\", \"since\": 2018}, {\"person\": 9, \"company\": \"acme\"}]"
mentdb
{"rows": 3, "batches": 1, "nodes_created": 0, "nodes_deleted": 0, "relationships_created": 2, "relationships_deleted": 0, "properties_set": 2, "labels_added": 0, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}
neo4j query <config> <cypher>
Description
Run a Cypher query: the rows
Run a Cypher query: the rows
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
admin
neo4j query "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "MATCH (p:Person) RETURN p.name AS name, p.age AS age ORDER BY name"
mentdb
[{"name": "Ana", "age": null}, {"name": "Bob", "age": 45}, {"name": "Zoé", "age": 31}]
a relationship and its nodes (fixed result: real Neo4j Community 5.26.0)
admin
neo4j query "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "MATCH (p:Person)-[r:WORKS_AT]->(c:Company) WHERE p.id = 1 RETURN p, r, c"
mentdb
[{"p": {"elementId": "4:d395b59e-c116-426e-9623-e60e465598b5:0", "labels": ["Person"], "properties": {"name": "Zoé", "id": 1, "age": 31}}, "r": {"elementId": "5:d395b59e-c116-426e-9623-e60e465598b5:0", "startNodeElementId": "4:d395b59e-c116-426e-9623-e60e465598b5:0", "endNodeElementId": "4:d395b59e-c116-426e-9623-e60e465598b5:3", "type": "WORKS_AT", "properties": {"since": 2020}}, "c": {"elementId": "4:d395b59e-c116-426e-9623-e60e465598b5:3", "labels": ["Company"], "properties": {"name": "ACME", "id": "acme", "city": "Saint-Denis"}}}]
neo4j query <config> <cypher> <json_params>
Description
Run a Cypher query with parameters
Run a Cypher query with parameters
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
json_params: The Cypher parameters as a JSON object, like {"id": 1} - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
json_params: The Cypher parameters as a JSON object, like {"id": 1} - String - required
admin
neo4j query "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "MATCH (p:Person)-[:WORKS_AT]->(c:Company {id: $company}) RETURN p.name AS name ORDER BY name" "{\"company\": \"acme\"}"
mentdb
[{"name": "Bob"}, {"name": "Zoé"}]
a path, with the transactional endpoint (same result shape) (fixed result: real Neo4j Community 5.26.0)
admin
neo4j query "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\", \"api\": \"tx\"}" "MATCH path = (p:Person {id: $id})-[:WORKS_AT]->(:Company) RETURN path" "{\"id\": 2}"
mentdb
[{"path": [{"elementId": "4:d395b59e-c116-426e-9623-e60e465598b5:1", "labels": ["Person"], "properties": {"name": "Bob", "id": 2, "age": 45}}, {"elementId": "5:d395b59e-c116-426e-9623-e60e465598b5:1", "startNodeElementId": "4:d395b59e-c116-426e-9623-e60e465598b5:1", "endNodeElementId": "4:d395b59e-c116-426e-9623-e60e465598b5:3", "type": "WORKS_AT", "properties": {"since": 2018}}, {"elementId": "4:d395b59e-c116-426e-9623-e60e465598b5:3", "labels": ["Company"], "properties": {"city": "Saint-Denis", "name": "ACME", "id": "acme"}}]}]
neo4j execute <config> <cypher>
Description
Run a Cypher statement and return its counters {nodes_created, nodes_deleted, relationships_created, relationships_deleted, properties_set, labels_added, labels_removed, indexes_added, indexes_removed, constraints_added, constraints_removed}
Run a Cypher statement and return its counters {nodes_created, nodes_deleted, relationships_created, relationships_deleted, properties_set, labels_added, labels_removed, indexes_added, indexes_removed, constraints_added, constraints_removed}
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
admin
neo4j execute "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "CREATE CONSTRAINT company_id IF NOT EXISTS FOR (c:Company) REQUIRE c.id IS UNIQUE"
mentdb
{"nodes_created": 0, "nodes_deleted": 0, "relationships_created": 0, "relationships_deleted": 0, "properties_set": 0, "labels_added": 0, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 1, "constraints_removed": 0}
neo4j execute <config> <cypher> <json_params>
Description
Run a statement with parameters, return its counters
Run a statement with parameters, return its counters
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
json_params: The Cypher parameters as a JSON object, like {"id": 1} - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
cypher: The Cypher query; give the values as $parameters, never by concatenation - String - required
json_params: The Cypher parameters as a JSON object, like {"id": 1} - String - required
admin
neo4j execute "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "MATCH (p:Person {id: $id}) SET p.age = $age" "{\"id\": 3, \"age\": 28}"
mentdb
{"nodes_created": 0, "nodes_deleted": 0, "relationships_created": 0, "relationships_deleted": 0, "properties_set": 1, "labels_added": 0, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}
neo4j transaction <config> <json_statements>
Description
Several statements in one transaction (transactional endpoint): Cypher texts or {cypher, params}. Returns one {rows, counters} per statement; on an error everything is rolled back and the error gives the statement number
Several statements in one transaction (transactional endpoint): Cypher texts or {cypher, params}. Returns one {rows, counters} per statement; on an error everything is rolled back and the error gives the statement number
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
json_statements: The statements as a JSON array - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
json_statements: The statements as a JSON array - String - required
admin
neo4j transaction "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "[{\"cypher\": \"MERGE (c:Company {id: $id}) SET c.name = $name\", \"params\": {\"id\": \"globex\", \"name\": \"Globex\"}}, {\"cypher\": \"MATCH (p:Person {id: 2})-[r:WORKS_AT]->() DELETE r\"}, {\"cypher\": \"MATCH (p:Person {id: 2}), (c:Company {id: 'globex'}) MERGE (p)-[:WORKS_AT {since: 2026}]->(c) RETURN c.name AS company\"}]"
mentdb
[{"rows": [], "counters": {"nodes_created": 1, "nodes_deleted": 0, "relationships_created": 0, "relationships_deleted": 0, "properties_set": 2, "labels_added": 1, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}}, {"rows": [], "counters": {"nodes_created": 0, "nodes_deleted": 0, "relationships_created": 0, "relationships_deleted": 1, "properties_set": 0, "labels_added": 0, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}}, {"rows": [{"company": "Globex"}], "counters": {"nodes_created": 0, "nodes_deleted": 0, "relationships_created": 1, "relationships_deleted": 0, "properties_set": 1, "labels_added": 0, "labels_removed": 0, "indexes_added": 0, "indexes_removed": 0, "constraints_added": 0, "constraints_removed": 0}}]
an error in the second statement: nothing is written (fixed result: real Neo4j Community 5.26.0)
admin
neo4j transaction "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "[\"CREATE (:Audit {at: 1})\", \"RETURN nope\"]"
mentdb
ERROR: Sorry, an error appears (the transaction was rolled back, statement 2: neo4j error Neo.ClientError.Statement.SyntaxError: Variable `nope` not defined (line 1, column 8 (offset: 7)) "RETURN nope" ^).
neo4j schema <config>
Description
The schema of the database: {labels, relationship_types, property_keys, indexes, constraints}
The schema of the database: {labels, relationship_types, property_keys, indexes, constraints}
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
admin
neo4j schema "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}"
mentdb
{"labels": ["Company", "Person"], "relationship_types": ["WORKS_AT"], "property_keys": ["a", "age", "at", "b", "city", "id", "k", "name", "since"], "indexes": [{"name": "company_id", "type": "RANGE", "entity_type": "NODE", "labels_or_types": ["Company"], "properties": ["id"], "state": "ONLINE"}, {"name": "index_343aff4e", "type": "LOOKUP", "entity_type": "NODE", "labels_or_types": null, "properties": null, "state": "ONLINE"}, {"name": "index_f7700477", "type": "LOOKUP", "entity_type": "RELATIONSHIP", "labels_or_types": null, "properties": null, "state": "ONLINE"}], "constraints": [{"name": "company_id", "type": "UNIQUENESS", "entity_type": "NODE", "labels_or_types": ["Company"], "properties": ["id"]}]}
neo4j request <config> <method> <path>
Description
The raw HTTP escape hatch: a path of the HTTP server (the credentials are sent). Returns the response text of a 2xx
The raw HTTP escape hatch: a path of the HTTP server (the credentials are sent). Returns the response text of a 2xx
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
method: GET, POST, PUT, DELETE, PATCH or HEAD - String - required
path: The path, like / - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
method: GET, POST, PUT, DELETE, PATCH or HEAD - String - required
path: The path, like / - String - required
admin
neo4j request "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "GET" "/"
mentdb
{"bolt_routing":"neo4j://127.0.0.1:7687","query":"http://127.0.0.1:7474/db/{databaseName}/query/v2","transaction":"http://127.0.0.1:7474/db/{databaseName}/tx","bolt_direct":"bolt://127.0.0.1:7687","neo4j_version":"5.26.0","neo4j_edition":"community"}
neo4j request <config> <method> <path> <json_body>
Description
The raw HTTP escape hatch with a JSON body
The raw HTTP escape hatch with a JSON body
Parameters
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
method: The method - String - required
path: The path - String - required
json_body: The JSON body - String - required
config: The Neo4j configuration as JSON: url (http://127.0.0.1:7474; endpoint is accepted as an alias; the HTTP port, not bolt), database (neo4j), username (neo4j) and password (the name of a secret: secret set), or token (the name of a secret: secret set) for a bearer token, api (auto: Query API v2 when the server has it (5.19+), else the transactional endpoint; query; tx), allow_plain (false: credentials over http are refused unless the host is localhost, 127.0.0.1 or ::1), timeout_ms (30000), max_bytes (64 MB), max_rows (100000) - String - required
method: The method - String - required
path: The path - String - required
json_body: The JSON body - String - required
admin
neo4j request "{\"url\": \"http://127.0.0.1:7474\", \"password\": \"neo4j_password\"}" "POST" "/db/neo4j/query/v2" "{\"statement\": \"MATCH (c:Company) RETURN count(c) AS n\"}"
mentdb
{"data":{"fields":["n"],"values":[[2]]},"bookmarks":["FB:kcwQ05W1nsEWQm6WI+YORlWYtSSQ"]}
