TigerGraph

TigerGraph Schema API

The Schema API from TigerGraph — 3 operation(s) for schema.

GitHub OpenAPI

Operations 3

GET /restpp/endpoints/{graph_name} List installed endpoints #
GET /gsql/v1/schema Retrieve graph schema metadata #
POST /restpp/ddl/{graph_name} Run a loading job (DDL) #

Documentation

📖
Documentation
https://docs.tigergraph.com/tigergraph-server/current/api/built-in-endpoints
📖
APIReference
https://docs.tigergraph.com/tigergraph-server/current/api/built-in-endpoints
📖
Documentation
https://docs.tigergraph.com/tigergraph-server/current/API/authentication
📖
Documentation
https://docs.tigergraph.com/savanna/main/
📖
APIReference
https://docs.tigergraph.com/cloud/main/solutions/access-solution/rest-requests

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tigergraph/refs/heads/main/openapi/tigergraph-schema-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/tigergraph/refs/heads/main/collections/tigergraph.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/tigergraph/refs/heads/main/collections/tigergraph.opencollection.json
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/tigergraph/refs/heads/main/plans/tigergraph-plans-pricing.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tigergraph-schema-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tigergraph-schema-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: TigerGraph REST++ Schema API
  description: Specification of the built-in TigerGraph REST++ API exposed by the TigerGraph database server.
  termsOfService: https://www.tigergraph.com/legal/
  contact:
    name: TigerGraph Support
    url: https://www.tigergraph.com/support/
  version: '1.0'
servers:
- url: http://localhost:9000
  description: Self-hosted REST++ server (default port 9000; unified on 14240 in 3.x+)
- url: https://{workspaceId}.i.tgcloud.io:443
  description: TigerGraph Savanna (Cloud) managed workspace over HTTPS
  variables:
    workspaceId:
      default: example
      description: TigerGraph Savanna workspace identifier
security:
- bearerAuth: []
tags:
- name: Schema
paths:
  /restpp/endpoints/{graph_name}:
    get:
      operationId: listEndpoints
      tags:
      - Schema
      summary: List installed endpoints
      description: Returns a list of built-in, dynamic (compiled GSQL query), and static (user-installed) endpoints and their parameters for the given graph.
      parameters:
      - $ref: '#/components/parameters/GraphName'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /gsql/v1/schema:
    get:
      operationId: getSchema
      tags:
      - Schema
      summary: Retrieve graph schema metadata
      description: Returns the schema metadata (vertex types, edge types, attributes) for a graph.
      parameters:
      - in: query
        name: graph
        required: false
        schema:
          type: string
        description: Graph name to scope the schema to.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /restpp/ddl/{graph_name}:
    post:
      operationId: runLoadingJob
      tags:
      - Schema
      summary: Run a loading job (DDL)
      description: Ingests data into a graph using a previously defined loading job.
      parameters:
      - $ref: '#/components/parameters/GraphName'
      - in: query
        name: tag
        required: true
        schema:
          type: string
        description: Name of the loading job to run.
      - in: query
        name: filename
        required: true
        schema:
          type: string
        description: Filename variable defined in the loading job.
      requestBody:
        required: true
        content:
          text/csv:
            schema:
              type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestppResponse'
components:
  schemas:
    RestppResponse:
      type: object
      properties:
        version:
          type: object
        error:
          type: boolean
        message:
          type: string
        results:
          type: array
          items:
            type: object
  parameters:
    GraphName:
      in: path
      name: graph_name
      required: true
      schema:
        type: string
      description: Name of the target graph.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from POST /restpp/requesttoken (required only when token authentication is enabled on the TigerGraph server).