REST API Overview

TigerGraph is API-first. Every operation in GraphStudio or the GSQL shell is executed via REST requests to the underlying server components.

1. Connectivity

The default ports and paths vary depending on whether you are using TigerGraph Server or TigerGraph Cloud.

Environment	Primary Port	Protocol
TigerGraph Server	14240	HTTP/HTTPS
TigerGraph Cloud	443	HTTPS

Connectivity Check

You can verify the status of the API server without authentication using the ping endpoint:

bashterminal
Copy
curl http://localhost:14240/api/ping
# Response: {"message": "pong", ...}

2. Authentication

Most endpoints require authentication. TigerGraph supports:

• Bearer Tokens: Generated via GSQL or the REST API.
• JWT (JSON Web Tokens): Supported in newer versions for GSQL-specific endpoints.
• Basic Auth: Primarily for internal or legacy usage.

3. Response Structure

TigerGraph returns JSON with a consistent top-level structure:

jsonterminal
Copy
{
  "error": false,
  "message": "Optional status message",
  "results": [],
  "code": "REST-0000"
}

4. RESTPP vs GSQL API

• RESTPP: The legacy engine primarily responsible for graph data operations (vertices, edges, and installed queries).
• GSQL v1 API: The modern API for schema management, user administration, and system metadata.