HugeGraph RESTful API
This section documents the REST API on current master. For historical APIs, switch to the versioned HugeGraph 1.7 RESTful API documentation or HugeGraph 1.5 RESTful API documentation.
The default graph space is
DEFAULT.
After starting Server, open http://localhost:8080/swagger-ui/index.html to view the OpenAPI page for the current version. See the usage example.
Graphs REST API: Manage graph instance lifecycle including creating, querying, cloning, clearing, and deleting graph databases.
Graphspace REST API: Multi-tenancy and resource isolation for creating, viewing, updating, and deleting graph spaces with prerequisites and constraints.
Authentication REST API: Manage users, roles, permissions, and access control to implement fine-grained graph data security.
Schema REST API: Query the complete schema definition of a graph, including property keys, vertex labels, edge labels, and index labels.
PropertyKey REST API: Define data types and cardinality constraints for all properties in the graph, serving as fundamental schema elements.
VertexLabel REST API: Define vertex types, ID strategies, and associated properties that determine vertex structure and constraints.
EdgeLabel REST API: Define edge types and relationship constraints between source and target vertices to construct graph connection rules.
IndexLabel REST API: Create indexes on vertex and edge properties to accelerate property-based queries and filtering operations.
Vertex REST API: Create, query, update, and delete vertex data in the graph with support for batch operations and conditional filtering.
Edge REST API: Create, query, update, and delete relationship data between vertices with support for batch operations and directional queries.
Variable REST API: Store and manage key-value pairs as global variables for graph-level configuration and state management.
Gremlin REST API: Execute Gremlin graph traversal language scripts via HTTP interface.
Cypher REST API: Execute OpenCypher declarative graph query language via HTTP interface.
Traverser REST API: Execute complex graph algorithms and path queries including shortest path, k-neighbors, similarity computation, and advanced analytics.
Task REST API: Query and manage asynchronous task execution status for long-running operations like index rebuilding and graph traversals.
Rebuild REST API: Rebuild graph schema indexes to ensure consistency between index data and graph data.
Rank REST API: Execute graph node ranking algorithms such as PageRank and Personalized PageRank for centrality analysis.
Metrics REST API: Retrieve runtime performance metrics, statistics, and health status data of the system.
Other REST API: Provide auxiliary functions such as version query, API listing, exception trace switch, IP allowlist and the Arthas agent.