​
The TigerGraphâ„¢ 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.
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".
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.
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. Below is a subset of the information returned.
To refresh a token:
If the ‘token’ is specified in /requesttoken endpoint and the method is PUT, the token will be refreshed if it exists.
To drop a token:
If the method is DELETE, the token will be dropped.
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.
In addition, there are required and optional parameters:
graph: (REQUIRED) the name of the graph
type: (OPTIONAL) the name of either a vertex type or an edge type
The output contains three top-level elements, GraphName, VertexTypes, and EdgeTypes. The following examples illustrate how to use /gsql/schema:
This endpoint returns all vertex and edge types within a graph, if no vertices or edges are specified. Here is an example of the results :
If a vertex type is specified, the only the description for that one vertex type is returned.
If an edge type is specified, the only the description for that one edge type is returned.
To support multiple graphs within one system, the graph data REST endpoint URLs include an optional graph name.
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.
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.
There are several optional parameters which may be used with either the GET or DELETE requests for /graph/ endpoints. See the Advanced Parameters section below.
The GET /graph/ endpoints can return at most 10240 items.
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.
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.
The delete operation is a cascading deletion. If a vertex is deleted, then all of the edges which connect to it are automatically deleted as well.
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.
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:
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/{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
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 on socialNet.
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:
=
equal to
!=
not equal to
>
greater than
>=
greater than or equal to
<
less than
<=
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, filter=name="GSQL"
. However, if the URL is itself enclosed in quotes, as is the case when a REST request is submitted using the curl
command, then the quotation marks around a string should be URL-encoded by replacing each mark with substring %22
.
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".
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
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.
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:
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".
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 loading data the 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 ashttps://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 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.
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.
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.
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 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.
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:
Machine name must not include https://
or similar! Just the hostname.
The words 'machine
', 'login
', and 'password
' are just keywords; the actual information is the stuff after those keywords.
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.
This endpoint reports statistics of running queries: the query's request ID, start time, expiration time, and the REST endpoint's url.
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.
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
To abort all queries, instead of using specific requestids, use requestid=all.
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.*
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.
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.
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.
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.
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
The /allpaths
endpoint has the following additional required parameter.
The current implementation of this endpoint will include paths with loops. Since it is possible to go around a loop an infinite number of times, it is important that you select the smallest value of maxLength which you consider appropriate. Even if there are no loops in your graph, a smaller maxLength will allow your query to run faster.
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.
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.
Type
Description
builtin
preinstalled in the TigerGraph system
dynamic
generated when compiling GSQL queries
static
user-installed endpoints
name
data type
default
description
tag
string
N.A.
loading job name defined in your DDL loading job (REQUIRED)
filename
string
N.A.
file variable name or filepath for the file containing the data (REQUIRED)
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.
name
data type
default
description
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.
new_vertex_only
bool
false
"false": Upsert vertices "true": Treat vertices as insert-only. If the input data refers to a vertex which already exists, do not update it.
vertex_must_exist
bool
false
"false": Always insert new edges. If a new edge refers to an endpoint vertex which does not exist, create the necessary vertices, using given id and default values for other parameters. "true": Only insert or update an edge If both endpoint vertices already exist.
Type
op
Meaning
1
"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, do not change this attribute.
2
"add" or "+"
Add the payload value to the existing value.
3
"and" or "&"
Update to the logical AND of the payload value and the existing value.
4
"or" or "|"
Update to the logical OR of the payload value and the existing value.
5
"max" or ">"
Update to maximum of the payload value and the existing value.
6
"min" or "<"
Update to minimum of the payload value and the existing va
Name
Path Type
/shortestpath
shortest path between the source and target vertex sets
/allpaths
all possible paths up to a given maximum path length between the source and target vertex sets
key
type
value
source
vertex object
Each path must start from this vertex. Mutually exclusive with sources.
sources
vertex array
Each path must start from one of these vertices. Mutually exclusive with source.
target
vertex object
Each path must end at this vertex. Mutually exclusive with targets.
targets
vertex array
Each path must end at one of theses vertices. Mutually exclusive with target.
vertexFilters
filter array
(OPTIONAL) Restrict the paths to those whose vertices satisfy any of the given filters. See details of filters above.
edgeFilters
filter array
(OPTIONAL) Restrict the paths to those whose edges satisfy any of the given filters. See details of filters above.
Key
Type
Description
maxLength
integer
(OPTIONAL) Maximum length of a shortest path. Default is 6.
allShortestPaths
boolean
(OPTIONAL) If true, the endpoint will return all shortest paths between the source and target. Default is false, meaning that the endpoint will return only one path.
Key
Type
Description
maxLength
integer
(REQUIRED) Maximum path length.
The request
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:
default
max_count
min_count
type
max_length
is_id
id_type
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.
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.
Example:
Assume the REST++ server is on the local machine (typical configuration) and there is a graph called socialNet. To get all the User vertices from socialNet:
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 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 called "socialNet".
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,
Example:
In the Collaborative Filter example in the GSQL Demo Examples document, the request
without postprocess formatting returns the following:
On the other hand,
returns this much more readable output:
The TigerGraph system administration can choose to enable user authentication for the REST++ endpoints. If authentication is not enabled, then TigerGraph REST++ endpoints are public; anyone with access to the HTTP ports of the TigerGraph server can run your endpoints. When REST++ authentication is enabled, then a valid authorization token must be included in the header. To see how to enable/disable REST++ authentication, see the document Managing User Privileges and Authentication.
The REST++ server implements OAuth 2.0-style authorization as follows: Each user can create one or more secrets (unique pseudorandom strings). Each secret is associated with a particular user and the user's privileges for a particular graph. Anyone who has this secret can invoke a special REST endpoint to generate authorization tokens (other pseudorandom strings). An authorization token can then be used to perform TigerGraph database operations via other REST endpoints. Each token will expire after a certain period of time. The TigerGraph default lifetime for a token is 1 month.
A user must have a secret before they create a token. Secrets are generated in GSQL (see Managing User Privileges and Authentication). The special endpoint /requesttoken is used to create a token. Either the GET or POST method may be used.
The GET method places the user's OAuth secret in the URL. The endpoint has two parameters:
secret (required for GET): the user's secret.
lifetime (optional): the lifetime for the token, in seconds. The default is one month, approximately 2.6 million seconds.
To use the POST method, the user's OAuth secret should be first written to a file, whose filename is passed as a parameter. The lifetime parameter specifies how long the token will be valid:
lifetime (optional): the lifetime for the token, in seconds. The default is one month, approximately 2.6 million seconds.
where secret.dat
is a text file containing one line: the user's secret.
Once REST++ authentication is enabled, a valid token should always be included in the HTTP header. If you are using curl to format and submit your REST++ requests, then use the following syntax:
For example, if the token = 01234567abcdefgh01234567abcdefgh, then the collaborative filtering example shown above would be
If the /requesttoken endpoint is used with the PUT command and the request token already exists, the given token will be refreshed.
If the DELETE command is used, the given request token will be deleted.
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.
By default, an HTTP request in the TigerGraph system times out after 16 seconds. to customize this timeout limit for a particular query instance, you can set the GSQL-TIMEOUT parameter in the request header. If you are using curl to submit your RESTPP request, the syntax would be the following:
You can specify the response size limit of a HTTP request with the following header:
If the response size is larger than the given limit, an error message will be returned instead of the actual query result: