HugeGraph RESTful API

⚠️ Version compatibility notes

  • HugeGraph 1.7.0+ introduces graphspaces, and REST paths follow /graphspaces/{graphspace}/graphs/{graph}.
  • HugeGraph 1.5.x and earlier still rely on the legacy /graphs/{graph} path, and the create/clone graph APIs require Content-Type: text/plain; 1.7.0+ expects JSON bodies.
  • The default graphspace name is DEFAULT, which you can use directly if you do not need multi-tenant isolation.
  • Note: Before version 1.5.0, the format of ids such as group/target was similar to -69:grant. After version 1.7.0, the id and name were consistent, such as admin HugeGraph 1.5.x RESTful API

Besides the documentation below, you can also open swagger-ui at localhost:8080/swagger-ui/index.html to explore the RESTful API. Here is an example

Graphspace API

Graphspace REST API: Multi-tenancy and resource isolation for creating, viewing, updating, and deleting graph spaces with prerequisites and constraints.

Schema API

Schema REST API: Query the complete schema definition of a graph, including property keys, vertex labels, edge labels, and index labels.

PropertyKey API

PropertyKey REST API: Define data types and cardinality constraints for all properties in the graph, serving as fundamental schema elements.

VertexLabel API

VertexLabel REST API: Define vertex types, ID strategies, and associated properties that determine vertex structure and constraints.

EdgeLabel API

EdgeLabel REST API: Define edge types and relationship constraints between source and target vertices to construct graph connection rules.

IndexLabel API

IndexLabel REST API: Create indexes on vertex and edge properties to accelerate property-based queries and filtering operations.

Rebuild API

Rebuild REST API: Rebuild graph schema indexes to ensure consistency between index data and graph data.

Vertex API

Vertex REST API: Create, query, update, and delete vertex data in the graph with support for batch operations and conditional filtering.

Edge API

Edge REST API: Create, query, update, and delete relationship data between vertices with support for batch operations and directional queries.

Traverser API

Traverser REST API: Execute complex graph algorithms and path queries including shortest path, k-neighbors, similarity computation, and advanced analytics.

Rank API

Rank REST API: Execute graph node ranking algorithms such as PageRank and Personalized PageRank for centrality analysis.

Variable API

Variable REST API: Store and manage key-value pairs as global variables for graph-level configuration and state management.

Graphs API

Graphs REST API: Manage graph instance lifecycle including creating, querying, cloning, clearing, and deleting graph databases.

Task API

Task REST API: Query and manage asynchronous task execution status for long-running operations like index rebuilding and graph traversals.

Gremlin API

Gremlin REST API: Execute Gremlin graph traversal language scripts via HTTP interface.

Cypher API

Cypher REST API: Execute OpenCypher declarative graph query language via HTTP interface.

Authentication API

Authentication REST API: Manage users, roles, permissions, and access control to implement fine-grained graph data security.

Metrics API

Metrics REST API: Retrieve runtime performance metrics, statistics, and health status data of the system.

Other API

Other REST API: Provide auxiliary functions such as system version query and API version information.

Page last updated February 2, 2026: BREAKING CHANGE: graduate as TLP & refactor a string of docs (#447) (655c3fd9)