Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion modules/API/pages/built-in-endpoints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2531,9 +2531,20 @@ If you install all queries and receive a state of `SUCCESS` for one or more quer
`+GET /restpp/query/{graph_name}/{query_name}+`

Each time a new TigerGraph query is installed, a dynamic endpoint is generated.
This new endpoint enables the user to run the new TigerGraph query through HTTP requests and giving the parameters in URL or in a data payload.
This endpoint enables users to run an installed TigerGraph query through HTTP requests by providing parameters in the URL or request payload.
In the case of a `GET` request, parameters should be passed in through the query string.

[NOTE]
Comment thread
Tushar-TG-14 marked this conversation as resolved.
====
TigerGraph provides both RESTPP and GSQL endpoints for running installed queries.

This RESTPP endpoint executes installed queries directly. The GSQL xref:api:gsql-endpoints.adoc#_run_query[Run query endpoint] internally forwards requests to this endpoint as part of the standardized GSQL API introduced in TigerGraph 4.1.

If your application does not require the standardized GSQL API, TigerGraph recommends using this RESTPP endpoint because it executes the query directly without the additional request forwarding.

For a comparison of the RESTPP and GSQL endpoints, including differences in parameter formats and request processing, see xref:api:gsql-endpoints.adoc#_comparing_the_restpp_and_gsql_query_endpoints[Comparing the RESTPP and GSQL query endpoints].
====

==== Parameters:

[%autowidth]
Expand Down
9 changes: 9 additions & 0 deletions modules/API/pages/gsql-endpoints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3212,6 +3212,15 @@ Sample Response::

The endpoint is used to run a query by its name.

[NOTE]
====
This endpoint provides a standardized GSQL API for running installed queries. Internally, it forwards requests to the RESTPP endpoint `GET /restpp/query/{graph_name}/{query_name}` to execute the query.

Use this endpoint if you are working with the standardized GSQL API or want consistency with other GSQL endpoints. If your application does not require the standardized GSQL API, consider using the xref:api:built-in-endpoints.adoc#_run_an_installed_query_get[RESTPP endpoint], which executes installed queries directly without the additional request forwarding.

For a comparison of the RESTPP and GSQL endpoints, including differences in parameter formats and request processing, see xref:#_comparing_the_restpp_and_gsql_query_endpoints[Comparing the RESTPP and GSQL query endpoints].
====

==== Endpoint Parameters:

[%autowidth]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,4 +255,4 @@ Ensure the data volume is mounted under `/data`, the RESTPP port matches the tar

* *DNS does not update*
+
Check the TTL value on the Route 53 record, verify the correct hostname was updated (UPSERT), and confirm the change with `nslookup`.
Check the TTL value on the Route 53 record, verify the correct hostname was updated (UPSERT), and confirm the change with `nslookup`.