Built-in Endpoints

System Utilities

GET /echo and POST /echo

These endpoints are simple diagnostic utilities which respond with the following message.

POST /echo has the same response as GET /echo.

GET /endpoints

This endpoint returns a list of the installed endpoints and their parameters. There are three types of endpoints, described in the table below.

To include one more more of the endpoint types in the output, include TypeName =true in the parameter query string for each type. For example, "builtin=true&static=true" will include builtin and static endpoints. If no type parameters are provided, all endpoints are returned.

There are over a dozen built-in endpoints, and some have several parameters, so the formatted JSON output from the builtin=true option is over 300 lines long. It is listed in full in Appendix A. To illustrate the format, we show a small excerpt: the output for the GET /echo and GET /endpoints endpoint.

GET /statistics/{graph_name}

This endpoint returns real-time query performance statistics over the given time period, as specified by the seconds parameter. The seconds parameter must be a positive integer less than or equal to 60. The REST++ server maintains a truncated log of requests from the current time and backward for a system-configured log_interval . Only those endpoints which have completed or timed out during the requested number of seconds and are within the log_interval will be included in the statistics report. For example:

The statistics data are returned in JSON format. For each endpoint which has statistics data, we return the following items:

  • CompletedRequests - the number of completed requests.

  • QPS - query per second.

  • TimeoutRequests - the number of requests not returning before the system-configured timeout limit. Timeout requests are not included in the calculation of QPS.

  • AverageLatency - the average latency of completed requests.

  • MaxLatency - the maximum latency of completed requests.

  • MinLatency - the minimum latency of completed requests.

  • LatencyPercentile - The latency distribution. The number of elements in this array depends on the segments parameter of this endpoint. By default, segments is 10, meaning the percentile range 0-100% will be divided into ten equal segments: 0%-10%, 11%-20%, etc.segments must be [1, 100].

Note: If there is no query sent in the past given seconds, a empty json will be returned.

GET /version

This endpoint returns the git versions of all components of the system. This can be useful information when requesting help from TigerGraph's support team.

GSQL Server Endpoints

It is also possible to send certain requests to the GSQL Server. There are two key differences:

  • Requests are sent to port 14240 (HTTP hub server) instead of 9000 (dedicated RESTPP server).

  • Username and password are required.

GET /gsqlserver/gsql/schema : Get Graph Schema metadata

Returns schema details about a vertex type, an edge type, or the entire graph schema.

Parameters:

  • graph: (REQUIRED) the name of the graph

  • type: (OPTIONAL) the name of either a vertex type or an edge type

Output: The output structure depends on whether type is a vertex type, an edge type, or is omitted. These three cases are described below.

Get One Vertex Type

If a vertex type is specified, the only the description for that one vertex type is returned. The JSON results object for a vertex type contains 4 fields:

  • "Name": the vertex type name, same as the input parameter "type"

  • "PrimaryId": details about the primary id

  • "Attributes": details about each attribute, listed in order

  • "Config": details about global properties of the vertex type

For example, to see details about the company vertex type in the workNet graph (see Example Graphs in the Appendix of GSQL Language Reference Part 2):

Get One Edge Type

If an edge type is specified, the only the description for that one edge type is returned. The JSON results for an edge type contains 6 fields:

  • "Name": the edge type name, same as the input parameter "type"

  • "FromVertexTypeName": FROM (source) vertex type name

  • "ToVertexTypeName": TO (target) vertex type name

  • "Attributes": details about each attribute, listed in order

  • "IsDirected": whether the edge is directed (true or false)

  • "Config": additional details about global properties of the edge type

For example, to see details about the worksFor vertex type in the workNet graph (see Example Graphs):

Get the Entire Graph Schema

If the type parameter is omitted, then the JSON results object will contain 3 fields:

  • "GraphName": the graph name, same as the input parameter "graph"

  • "VertexTypes": an array of vertex schema objects. Each vertex schema object is exactly the JSON output if that specific vertex type had been specified.

  • "EdgeTypes": an array of edge schema objects. Each edge schema object is exactly the JSON output if that specific edge type had been specified.

For example, to see details about the entire workNet graph (see Example Graphs):

For brevity, some details which were shown in the One Vertex Type and One Edge Type examples above have been truncated.

GET /gsqlserver/gsql/queryinfo: Get Query Metadata

Returns metadata details about a query. In particular, it lists the input parameters and output PRINT statement syntax.

Parameters:

  • graph: (REQUIRED) the name of the graph

  • query: (REQUIRED) the name of the query

Output: The JSON output contains three fields:

  • "queryname": The name of the query, same as the query input parameter.

  • "input": an unordered list of the input parameter names and data types.

  • "output": a JSON structure which follows the same structure of the query's output. For each key-value pair, the key is the name which will appear in the query output. Instead of the data you would expect when running a query, the values are data types.

Example: In the GSQL Language Reference, the query to_vertex_setTest is used to demonstrate the to_vertex_set() function. Its signature is to_vertex_setTest (SET<STRING> uids, STRING uid, STRING vtype). It has four PRINT statements.

Accessing and Modifying the Graph Data

GET /graph/{graph_name}/vertices

This endpoint returns all vertices having the type vertex_type in the graph called graph_name . graph_name is optional if the database has only one graph but required for a database with multiple graphs. Optionally, the user can instead chose a particular vertex by including its primary_id at the vertex_id field . For example:

/graph/{graph_name}/vertices has an optional parameter "count_only". The default value is false. If it is true, the results field contains only the number of vertices selected.

GET /graph/{graph_name}/edges

This endpoint returns all edges which connect to a given vertex ID in the graph called graph_name . graph_name is optional if the database has only one graph but required for a database with multiple graphs.A source vertex ID must be given. The user may optionally specify the edge type, the target vertex type, and the target vertex ID. The URL format is as follows:

  • edge_type - type name of the edges. Use "_" to permit any edge type. Omitting the edge_type field from the URL also permits any edge type. However, skipping edge_type also means that target_vertex_type and target_vertex_id must be skipped.

  • target_vertex_type - type name of the target vertices.

  • target_vertex_id - ID of the target vertex.

Here is a simple example:

/graph/{graph_name}/edges has two optional parameters "count_only" and "not_wildcard":

  • count_only : If it is true, the results contains only the number of edges selected. The default value is false.

  • not_wildcard : This determines how the edge type name "_" is interpreted. If false (which is the default), "_" means all edge types are included. If not_wildcard is true, "_" is interpreted literally to select only edges with edge type name equal to underscore.

DELETE /graph/{graph_name}/vertices

This endpoint deletes the given vertex(vertices) in the graph called graph_name . graph_name is optional if the database has only one graph but required for a database with multiple graphs. The URL structure and semantics are analogous to those in GET /graph/{graph_name}/vertices. This endpoint has an additional parameter "permanent", whose default value is false. If "permanent" is true, the deleted vertex ids can never be inserted back, unless the graph is dropped or the graph store is cleared.

DELETE /graph/{/graph_name}/edges

This endpoint deletes the given edge(s). graph_name is optional if the database has only one graph but required for a database with multiple graphs. The URL structure and semantics are analogous to those in GET /graph/{graph_name}/edges.

Advanced Parameters for /graph/{graph_name}/vertices and /graph/{graph_name}/edges

The above four endpoints, GET /graph/{graph_name}/vertices, GET /graph/{graph_name}/edges, DELETE /graph/{graph_name}/vertices, and DELETE /graph/{graph_name}/edges, have optional URL parameters for further operations:

  1. Select : Specify which attributes to be returned (GET only).

  2. Filter : Apply a filter on the vertices or edges, based on their attribute values.

  3. Limit : Limit the total number of vertices or edges.

  4. Sort : Sort the data. (For DELETE, sort should be used with limit together.)

  5. Timeout : Timeout in seconds. If set to 0, use system wide endpoint timeout setting.

Select

By default the GET /graph/{graph_name}/vertices and /graph/{graph_name}/edges endpoints return all the attributes of the selected vertices or edges. The select parameter can be used to specify either the desired or the undesired attributes. The format is select=attribute_list, where attribute_list is a list of comma-separated attributes. Listing an attribute name means that this attribute should be included, while an attribute name preceded by a minus sign means that this attribute should be excluded. An underscore means all attributes.

  • http://server_ip:9000/graph/{graph_name}/vertices?select=attr1,attr2 returns only attributes attr1 and attr2

  • http://server_ip:9000/graph/{graph_name}/vertices?select=-attr1,-attr2 returns all attributes except attributes attr1 andattr2

  • http://server_ip:9000/graph/{graph_name}/vertices?select=-_ returns no attribute at all

Example Query: Return the date_time attribute of all product vertices on socialNet.

Filter

The filter parameter is a set of conditions analogous to the WHERE clause in industry-standard SQL language. The format is filter=filter_list, where filter_list is a list of comma-separated filters, and each filter is the concatenation of an attribute, an operator, and a value (with no white spaces separating the parts). The following six comparison operators are supported:

  1. = equal to

  2. != not equal to

  3. > greater than

  4. >= greater than or equal to

  5. < less than

  6. <= less than or equal to

Here is an example request: It returns all User vertices with age greater than or equal to 30.

Limit

The Limit parameter is used to set a limit on the number of vertices or edges returned from a query request. Note that there is also a system limit of 10240 on the number of vertices or edges returned. The user-defined limit cannot exceed this system limit.

The following example returns up to 3 User vertices on graph "socialNet".

Sort

The Sort parameter returns results sorted by given attributes. The format is sort=list_of_index_attributes. The results are sorted by the first attribute first, and so on. Groups of the sorted results which have identical values on the first attribute are then sorted by the second attribute, and so on. Below are some examples:

  • http://server_ip:9000/graph/{graph_name}/vertices?sort=attr1 sort by attribute attr1 in ascending order

  • http://server_ip:9000/graph/{graph_name}/vertices?sort=-attr1 sort by attribute attr1 in descending order

  • http://server_ip:9000/graph/{graph_name}/vertices?sort=attr1,-attr2 first sort by attr1 in ascending order, then sort by attr2 in descending order

DELETE /graph/{graph_name}/delete_by_type/vertices

This endpoint deletes all vertices of the given vertex type in the graph called graph_name . graph_name is optional if the database has only one graph but required for a database with multiple graphs. This endpoint has two additional parameters "permanent" and "ack". The "permanent" parameter is the same as the "permanent" parameter for endpoint DELETE /graph/{graph_name}/vertices. "ack" specifies whether RESTPP needs to get acknowledgement from GPEs. If "ack" is set to "none", it doesn't need to get acknowledgement from any GPE. If "ack" is set to "all" (default), it needs to get acknowledgement from all GPEs.

POST /builtins/{graph_name}

This endpoint provides statistics for the graph called graph_name . graph_name is optional if the database has only one graph but required for a database with multiple graphs. A JSON object must be given as a data payload in order to specify the function and parameters. In the JSON object, the keyword "function" is used to specify the function. Below are the descriptions of each function:

stat_vertex_attr

This function returns the minimum, maximum, and average values of the given edge type's int, uint, float and double attributes, and the count of true and false of a bool attribute. There is one parameter:

  • type: The vertex type name, or "*", which indicates all vertex types.

Below is an example request on socialNet and its output. The vertex type "Person" has a uint attribute "age".

stat_edge_attr

Similar to stat_vertex_attr, this function returns the statistics of the minimum, maximum, and average of the given edge type's int, uint, float and double attributes, and the count of true and false of a bool attribute. Note each undirected edge is counted twice. There are three parameters:

  • type: The edge type name, or "*", which indicates all edge types.

  • from_type: Given a vertex type, the function only includes edges whose source vertex type is the given type. "*" indicates all types. Default is all types. If a specific edge type is given, giving a correct from_type can speed up the process.

  • to_type: Given a vertex type, the function only includes edges whose destination vertex type is the given type. "*" indicates all types. Default is all types.

Below is an example request and its output. The edge type "Liked" has a float attribute "strength".

stat_vertex_number

This function returns the number of vertices of the given vertex type. There is one parameter.

  • type: The vertex type name, or "*", which indicates all vertex types.

Below is an example request and its output.

stat_edge_number

This function returns the number of edges of the given type. There are three parameters.

  • type: The edge type name, or "*", which indicates all edge types.

  • from_type: Given a vertex type, the function only those edges whose source vertex type is the given type. "*" indicates all types. Default is all types. If a specific edge type is given, giving a correct from_type can speed up the process.

  • to_type: Given a vertex type, the function counts only those edges whose destination vertex type is the given type. "*" indicates all types. Default is all types.

POST /ddl/{graph_name} - Run a Loading Job

This endpoint is for loading data into the graph called graph_name. graph_name is optional if the database has only one graph but required for a database with multiple graphs. For more details, please see GSQL Language Reference Part 1 - Defining Graphs and Loading Data.

This endpoint submits data as an HTTP request payload, to be loaded into the graph by the DDL Loader. The data payload can be formatted as generic CSV or JSON. This endpoint accepts five parameters:

Note that if you have special characters in your parameter values, the special characters should use URL encoding. For example, if your eol is '\n', it should be encoded as %0A. Reference guides for URL encoding of special characters can found on the web, such as https://www.w3schools.com/tags/ref_urlencode.asp . To avoid confusion about whether you should you one or two backslashes, we do not support backslash escape for this eol or sep parameter.

Note that if your loading job defines multiple file sources, you will need to call the endpoint multiple times, once for each file as you can only pass one file to the endpoint at a time. LOAD statements utilising file definitions not referenced in the filename tag will be skipped.

The maximum size of data you can upload via this endpoint is controlled by the Nginx.ClientMaxBodySize configuration parameter (default is 128 MB).

POST /graph/{graph_name} - Upsert the given data

This endpoint upserts vertices and/or edges into the graph called graph_name. graph_name is optional if the database has only one graph but required for a database with multiple graphs. "Upsert" means that if the target vertex or edge does not yet exist, it is insert; if it does exist, it is updated. The endpoint offers some parameters which can fine tune this behavior.

This endpoint accepts three parameters:

The response is the number of vertices and edges that were accepted. The API uses JSON format to describe the vertices and edges to be upserted. The JSON code can be stored in a text file or specified directly in a command line. There is a maximum size for a POST data payload (see the Size Limits section). The JSON format for describing a vertex set or edge set is summarized below. The identifiers in bold are keywords. The italicized terms should be replaced with user-specified values. Moreover, multiple instances may be included at the italicized levels. See the example below for clarification.

Payload (Input) Data

The payload data should be in JSON according the schema shown below:

The fields in <angle_brackets> are placeholder names or values, to be replaced with actual values. The keys in <angle_brackets>, such as <vertex_type>, can be repeated to form a list of items. The keys which are not in angle brackets are the exact text which must be used. The nested hierarchy means that vertices are grouped by type. Edges on the other hand, are first grouped by source vertex type, then vertex id, then edge type.

The first example below shows two User vertices having an attribute called attr1. Op codes are explained below.

The second example starts with one User vertex. If id6 already exists, it is not changed. If it doesn't yet exist, it is created with default attribute values. Then two edges are created: a Liked edge from id1 to id6, and then a Liked_By edges from id6 to id1.

Operation codes

Each attribute value may be accompanied by an operation (op) code, which provides very sophisticated schemes for data update or insertion:

If an attribute is not given in the payload, the attribute stays unchanged if the vertex/edge already exists, or if the vertex/edge does not exist, a new vertex/edge is created and assigned the default value for that data type. The default value is 0 for int/uint, 0.0 for float/double, and "" for string.

Invalid data types cause the request to be rejected

The RESTPP server validates the request before updating the values. The following schema violations will cause the entire request to fail and no change will be made to a graph:

  • For vertex upsert:

  1. Invalid vertex type.

  2. Invalid attribute data type.

  • For edge upsert:

  1. Invalid source vertex type.

  2. Invalid edge type.

  3. Invalid target vertex type.

  4. Invalid attribute data type.

If an invalid attribute name is given, it is ignored.

Output response

The response is the number of vertices and edges that were accepted. Additionally, if new_vertex_only is true, the response will include two more fields:

  • skipped_vertices: the number of vertices in the input data which already existed in the graph

  • vertices_already_exist: the id and type of the input vertices which were skipped

If vertex_must_exist is true, the response will include two more fields:

  • skipped_edges: the number of edges in the input data rejected because of missing endpoint vertices

  • miss_vertices: the id and type of the endpoint vertices which were missing

The following example file add_id6.json upserts one User vertex with id = " id6 ", one Liked edge, and one Liked_By edge. The Liked edge is from " id1 " to " id6 "; the Liked_By edge is from " id6 " to " id1 ".

The following example submits an upsert request by using the payload data stored in add_id6.json.

POST /gsqlserver/interpreted_query - Run an interpreted query

This endpoint runs a GSQL query in Interpreted Mode. The query body should be supplied at the data payload, and the query's parameters are supplied as the URL's query string.

This request goes directly to the GSQL server (port 14240) instead of the the RESTPP server (port 9000), so the username and password must be specified in the header. If you are using curl, you can use the -u option as shown below:

If you do not want the password to be included in the request, there are ways to have the username and password stored in a file and then to reference the file. The following method by Pierre D is published in https://stackoverflow.com/questions/2594880/using-curl-with-a-username-and-password:

The format of the password file is (as per man curl):

Note:

  1. Machine name must not include https:// or similar! Just the hostname.

  2. The words 'machine', 'login', and 'password' are just keywords; the actual information is the stuff after those keywords.

Managing Running Queries

Once a query has been started, it is assigned a request ID. There are built-in endpoints to report on all running queries and to abort queries.

Get Running Queries /showprocesslist/{graph_name}

This endpoint reports statistics of running queries: the query's request ID, start time, expiration time, and the REST endpoint's url.

Abort a Query /abortquery/{graph_name}

The /abortquery endpoint safely aborts the selected query or queries. Either the GET or POST method may be used.

The following examples show how the options are used to specify which queries to abort.

Abort Query with Given RequestID

To abort one query request, use the requestid parameter to specify its request (obtained from /showprocesslist), e.g., ?requestid=16842763.RESTPP_1_1.1561401340785.N

To abort multiple query requests, simply use the requestid parameter multiple times, e.g., ?requestid=16842763.RESTPP_1_1.1561401340785.N&requestid=16973833.RESTPP_1_1.1561401288421.N

Abort All Queries

To abort all queries, instead of using specific requestids, use requestid=all.

Abort Queries by Endpoint

To abort all queries of a given endpoint or endpoints, there is an option to input a string for the query's REST endpoint url. You must specify the base of the endpoint's url, but then use a wildcard to allow for different parameters. For example, to abort all running queries for the endpoint /sleepgpe, use url=/sleepgpe.*

Path-Finding Algorithms

The TigerGraph platform comes with two built-in endpoints, /shortestpath and /allpaths, which return either the shortest or all unweighted paths connecting a set of source vertices to a set of target vertices. The table below summarizes the two path-finding endpoints.

Input Parameters and Output Format for Path-Finding

Each REST endpoint reads a JSON-formatted payload that describes the input parameters. These parameters specify which vertices and edges may be on the paths, additional conditions on the attributes of the vertices and edges, and the maximum length of a path.

Source and target vertices

Each endpoint must have either a source or sources key and either a target or targets parameter. The source and target parameters describe a single vertex. The format for a vertex object is as follows: {"type" : "<vertex_type_name>", "id" : "<vertex_id>"}. The sources and targets parameters are JSON arrays containing a list of vertex objects.

Filters The payload may also have an array of filter conditions, to restrict the vertices or edges in the paths. Each individual filter is a JSON object which describes a condition on one vertex type or edge type. A filter object has one or two key-value pairs: {"type": "<vertex_or_edge_type>", "condition": "<attribute_condition>"}

  • "type": the vertex type or edge type to be filtered

  • "condition" (optional): a boolean expression on one attribute of the given vertex type or edge type. "AND" and "OR" may be used to make compound expressions.

Example of a filter array:

Note that all filtering conditions in vertexFilters and edgeFilters are combined with the "OR" relationship, i.e., if a vertex (or edge) fulfills any one of the filter conditions, then this vertex (or edge) will be included in the resulting paths.

Output

The JSON output is a list of vertices and a list of edges. Each vertex and each edge is listed in full, with all attributes. The collections of vertices and edges are not in path order.

POST /shortestpath/{graphName} (Shortest Path Search)

The /shortestpath endpoint has the following additional parameters.

The example below requests a single shortest path between the source vertex set {VidUser 2} and the target vertex set {VidUsers 0 and 3}. The path contains edges of type User_Video whose attributes fulfill the predicate rating > 5 and date_time > 1000. The result is a single path consisting of 3 vertices and 2 edges: VidUser 0 -- (User_Video edge) -- Video 0 -- (User_Video edge) -- VidUser 3

To get all shortest paths between the above source and target vertex sets, we can simply do so by specifying the allShortestPaths parameter is true. Now we get two paths. The paths partially overlap, so we get a total of 4 vertices and 3 edges: VidUser 0 -- (User_Video edge) -- Video 0 -- (User_Video edge) -- VidUser 3 VidUser 0 -- (User_Video edge) -- Video 0 -- (User_Video edge) -- VidUser 2

POST /allpaths/{graphName} (All Paths Search)

The /allpaths endpoint has the following additional required parameter.

The example below requests all paths between the source vertex set {Video 0} and the target vertex set {AttributeTag "action"}, up to maximum length 3. The path may only contain Video vertices where year >= 1984. The result includes 3 paths: AttrributeTag "action" -- Video 0 AttrributeTag "action" -- Video 3 -- VidUser 4 -- Video 0 AttrributeTag "action" -- Video 2 -- VidUser 0 -- Video 0

Other versions of path finding algorithms are available in the GSQL Graph Algorithm Library.

Dynamically Generated Endpoints

Each time a new TigerGraph query is installed, a dynamic endpoint is generated and stored at installation_directory/config/endpoints_dynamic. This new endpoint enables the user to run the new TigerGraph query by using curl commands and giving the parameters in URL or in a data payload. See the document "GSQL Language Specification, Part 2: Queries" Section "Running a Query" for more details. For example, the following TigerGraph query can generate a corresponding endpoint in <installation_directory>/config/endpoints_dynamic:

The "payload" object enables the query being executed by giving a data payload. The "parameter" object includes the query parameters.

To execute this query, with parameter p=0, the following curl command can be used:

Log Files

The REST servers log files are located in <installation_directory>/logs.