GSQL v1 API

Introduced in TigerGraph 4.0, the GSQL v1 API provides a modern, standardized interface for administrative tasks that were previously handled by diverse internal components.

1. Schema Management

You can perform full CRUD operations on your graph schema using JSON payloads instead of GSQL statements.

List Schema Objects

Show Vertices: GET /gsql/v1/schema/vertices?graph={name}
Show Edges: GET /gsql/v1/schema/edges?graph={name}
Show Graphs: GET /gsql/v1/schema/graphs

Creating Schema via JSON

Instead of writing GSQL DDL, you can POST a JSON definition:


bashterminal
curl -X POST "http://localhost:14240/gsql/v1/schema/vertices" \
     -d '{"createVertices": [{"Name": "User", "PrimaryId": {"Name": "id", "AttributeType": {"Name": "UINT"}}}]}'

2. Index Management

The v1 API allows for programmatic creation and deletion of secondary indexes.

Create Index: POST /gsql/v1/schema/indexes?graph={name}
Drop Index: DELETE /gsql/v1/schema/indexes/{indexName}?vertex={vertexType}

3. Query Lifecycle

Endpoints for managing GSQL queries:

Install Query: POST /gsql/v1/queries?graph={name}
List Running Queries: GET /gsql/v1/queries/running
Abort Query: DELETE /gsql/v1/queries/running/{request_id}

4. System Utilities

Component Versions

GET /gsql/v1/system/versions Returns the exact Git hash and release version for every service (GPE, GSE, RESTPP, etc.).

[!TIP] The GSQL v1 API is the recommended way to automate TigerGraph configuration in CI/CD pipelines, as it provides predictable JSON responses.

BOOK