Copyright © 2015-2017 TigerGraph. All Rights Reserved.
For technical support on this topic, contact firstname.lastname@example.org with a subject line starting with "REST++"
- 1 Introduction – What is REST++?
- 2 Submitting a REST++ Request
- 3.1 System Utilities
Accessing and Modifying the Graph Data
- 3.2.1 GET /graph/vertices
- 3.2.2 GET /graph/edges
- 3.2.3 DELETE /graph/vertices
- 3.2.4 DELETE /graph/edges
- 3.2.5 Advanced Parameters for /graph/vertices and /graph/edges
- 3.2.6 DELETE /graph/delete_by_type/vertices
- 3.2.7 POST /builtins
- 3.2.8 POST /ddl
- 3.2.9 POST /graph
- 3.3 Dynamically Generated Endpoints
- 3.4 Log Files
- 4 Appendix A - JSON Catalog of Built-in Endpoints
Introduction – What is REST++?
The TigerGraph TM system uses the well-known REpresentational State Transfer (REST) architecture to manage communication with the TigerGraph core components, the Graph Processing Engine (GPE) and Graph Storage Engine (GSE). REST++ (or RESTPP) is the TigerGraph customized REST server. (See Figure 1 below) When an upper layer component, such as the Platform Web UI or GSQL, wishes to access the graph engine, it sends a request to the REST++ server. Users can also communicate directly with the REST++ server, either by using one of the standard REST APIs included with the system, or by authoring and then employing a custom endpoint API. This document describes the APIs for the built-in endpoints, which provides methods for basic querying and manipulation of the graph data.
Figure 1 : TigerGraph System Block Diagram
Like most RESTful systems, REST++ employs the HTTP protocol (specifically HTTP/1.1 without request pipelining). Accordingly, REST APIs feature request methods and URLs, response status codes, and data responses. This guide describes the request methods and URLs used to query, update, and delete from the graph data. It also describes the format of the data responses.
The TigerGraph REST APIs employ three HTTP request methods:
GET is used to request data.
POST is used to send data.
DELETE is used to delete data.
If the user submits an unsupported HTTP method, the API will return an error message: "endpoint not found".
Submitting a REST++ Request
To submit a request, an HTTP request is sent to the REST++ server. By default, the REST++ server listens for requests at port 9000. A request needs to specify three things:
the request method (GET, POST, or DELETE),
the endpoint address, and
any required or optionally request parameters.
The endpoint address is the the form of a HTTP URL.
Request parameters are appended to the end using standard HTTP query string format.
In a test or development environment, the requester may be on the same server as REST++. In this case, the server_ip is localhost .
The Linux curl command is the most convenient way to submit the HTTP request to the REST++ server.
Assume the REST++ server is on the local machine (typical configuration). To get all the User vertices from the current graph:
To list only the first three vertices, we can set limit = 3:
The HTTP request methods GET, POST, and DELETE are case sensitive. Also, curl option flags are case sensitive.
Input Data for POST
Input data for POST requests should be in JSON format. There are two ways to supply the data: inline or in a separate file.
The data should be formatted as a single string without linebreaks. Use the curl - d option, followed by the JSON string.
The following example uses the POST /graph endpoint to insert one User type vertex whose id value is "id6" into the graph.
Often it will be more convenient for the input data to be in a separate file, especially if it is large.
Use the curl option --data-binary @path_to_file as in the example below:
If we now store the data string in a file (say, my_input.json), then the example above becomes the following:
All TigerGraph REST responses are in JSON format. The format details for each built-in endpoint are described below in the Built-in Endpoints section. By default, the output is designed for machine reading, with no extra spaces or linefeeds. The output JSON object can have three fields: error, message, and result.
This document has been updated to show JSON output API v2. Earlier versions of the TigerGraph platform produced JSON output in a slightly different format (v1). Newer platforms can be configured to produce output in either v2 or v1 formats.
To make the output more human readable, use the jq command or Python json library built into most Linux installations. Specifically,
In the Collaborative Filter example in the GSQL Tutorial and Demo Examples document, the request
without postprocess formatting returns the following:
On the other hand,
returns this much more readable output:
The maximum length for the request URL is 8K bytes, including the query string. Requests with a large parameter size should use a data payload file instead of inline data.
The maximum size for a request body, including the payload file, is set by the system parameter nginx.client_max_body_size. The default value is 128 (in MB). To increase this limit to xxx MB, use the following gadmin command:
The upper limit of this setting is 1024 MB. Raising the size limit for the data payload buffer reduces the memory available for other operations, so be cautious about increasing this limit.
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.
This endpoint returns a list of the installed endpoints and their parameters. There are three types of endpoints, described in the table below.
preinstalled in the TigerGraph system
generated when compiling GSQL queries
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.
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.
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.
Accessing and Modifying the Graph Data
This endpoint returns all vertices having the type vertex_type . Optionally, the user can instead chose a particular vertex by including its primary_id at the vertex_id field . For example:
/graph/vertices has an optional parameter "count_only". The default value is false. If it is true, the results field contains only the count of the result vertices.
This endpoint returns all edges which connect to a given vertex ID. 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.
/graph/edges has two optional parameters "count_only" and "not_wildcard":
- count_only: If it is true, the results contains only the count of the result edges. 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.
This endpoint deletes the given vertex(vertices). The URL is exactly the same as GET /graph/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.
This endpoint deletes the given edge(s). The URL is exactly the same as GET /graph/edges.
Advanced Parameters for /graph/vertices and /graph/edges
The above four endpoints, GET /graph/vertices, GET /graph/edges, DELETE /graph/vertices, and DELETE /graph/edges, have optional URL parameters for further operations:
- Select: Specify which attributes to be returned (GET only).
- Filter: Apply a filter on the vertices or edges, based on their attribute values.
- Limit: Limit the total number of vertices or edges.
- Sort: Sort the data. (For DELETE, sort should be used with limit together.)
- Timeout: Timeout in seconds. If set to 0, use system wide endpoint timeout setting.
The parameter 'Limit' can reduce the search space and leads to quick response of queries. However if Limit and Sort are both provided, the query still needs to traverse all potential vertices/edges and it might lead to slow query response on large graph.
By default the GET /graph/vertices and /graph/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.
It is illegal to specify both desired and undesired attributes in the same request.
Example Query: Return the date_time attribute of all product vertices.
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:
!=not equal to
>=greater than or equal to
<=less than or equal to
Here is an example request: It returns all User vertices with age greater than or equal to 30.
Literal strings should be enclosed in double quotation marks. For example,
. However, if the URL is itself enclosed in quotes, as is the case when a REST request is submitted using the
command, then the quotation marks around a string should be URL-encoded by replacing each mark with substring
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.
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:
This endpoint deletes all vertices of the given vertex type. This endpoint has two additional parameters "permanent" and "ack". The "permanent" parameter is the same as the "permanent" parameter for endpoint DELETE /graph/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.
This endpoint provides statistics. 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:
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 and its output. The vertex type "Person" has a uint attribute "age".
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".
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.
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.
This endpoint is for data loading. For more detai ls, please see GSQL Language Reference Part 1 - Defining Graphs and Loading Data v1.1
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:
|tag||string||N.A.||loading job name defined in your DDL loading job|
|sep||one character string||,||separator of CSV data. If your data is JSON, you do not need to specify this parameter.|
|eol||one or two character string||\n||end-of-line character. Only one character is allowed, except for the special case "\r\n"|
|ack||string, can only be "all" or "none"||"all"||
"all": request will return after all GPE instances have acknowledged the POST
"none": request will return immediately after RESTPP processed the POST.
|timeout||UINT32||0||Timeout in seconds. If set to 0, use system-wide endpoint timeout setting.|
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.
This endpoint can upsert vertices and/or edges into the graph. Due to the cost of checking for the existence of an edge or a vertex, the standard API does not support separate update and create (insert) operations. Instead, an upsert operation, a combination of update and insert, is provided. If the target vertex or edge already exists, it is updated with the values specified in the request. If the vertex or edge does not yet exist, the action depends on the operator chosen by the user. Some operators will direct the endpoint to create a new vertex or edge using the attribute values in the request.
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.
For each attribute , we need to specify its value and op . The operator controls how the value and a possible existing value in the vertex / edge are aggregated. We support the following operators:
|1||"overwrite" or "="||Create a new vertex/edge with these values, or overwrite the existing value. This is the default operation if op is not given.|
|2||"ignore_if_exists`" or "~"||If the vertex/edge does not exist, use the payload value to initialize the attribute; but if the vertex/edge already exists (which means the values of all attributes exist), do not change this attribute.a|
|3||"add" or "+"||Add the payload value to the existing valu e.|
|4||"and" or "&"||Update to the logical AND of the payload value and the existing value.|
|5||"or" or "|"||
Update to the logical OR of the payload value and the existing value.
|6||"max" or ">"||Update to maximum of the payload value and the existing value.|
|7||"min" or "<"||Update to minimum of the payload value and the existing value.|
Types 3 through 7 should only be used if the selected vertices or edges exist. If any of these operators is requested for an non-existing vertices or edges, the entire request is rejected.
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 assigne d default values . The default value is 0 for int/uint, 0.0 for float/double, and "" for string.
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:
Invalid vertex type.
Invalid attribute data type.
- For edge upsert:
Invalid source vertex type.
Invalid edge type.
Invalid target vertex type.
Invalid attribute data type.
If an invalid attribute name is given, it is ignored.
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.
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:
The REST servers log files are located in <installation_directory>/logs.
Appendix A - JSON Catalog of Built-in Endpoints
generates the following output, appropriately 400 lines long when formatted. In addition to listing each endpoint, the JSON output also lists all the required and optional parameters for each endpoint. In turn, each parameter is described by some or all of these attributes:
While this information alone is not sufficient for a full understanding of each endpoint, the descriptive names of parameters and the attribute values go a long way towards this goal.