Built-in Endpoints

Built-in endpoints are preinstalled and provide standard access to your graph data and system health.

1. Graph Data Inspection

Retrieve or manipulate specific data points directly via REST.

Retrieve Vertices

GET /restpp/graph/{graph_name}/vertices/{vertex_type}/{vertex_id}


bashterminal
curl -X GET "http://localhost:14240/restpp/graph/social/vertices/Person/user1"

List Edges

GET /restpp/graph/{graph_name}/edges/{vertex_type}/{vertex_id}/{edge_type} Returns all edges connected to a specific vertex.

2. System Monitoring

These endpoints are used to integrate TigerGraph with external observability tools.

Informant Metrics

GET /informant/metrics Returns system metrics (CPU, Memory, Disk) in OpenMetrics format, compatible with Prometheus and Datadog.

Query Performance

GET /restpp/statistics/{graph_name} Returns real-time performance data (QPS, Average Latency, Min/Max Latency) for all queries executed in the last $N$ seconds.

3. Graph Maintenance

Rebuild Graph Engine

POST /restpp/rebuildnow/{graph_name} Triggers an immediate commit of in-memory data to disk. Useful after heavy loading jobs.

Deleted Vertex Check

GET /restpp/deleted_vertex_check A diagnostic utility to ensure the storage engine (GSE) and processing engine (GPE) are in sync regarding deleted vertices.

[!NOTE] In TigerGraph 4.x, many legacy RESTPP paths were moved to the /gsql/v1/ prefix for better standardization.

BOOK