HOWTO: Using REST API with TigerGraph

We prepared a collection of TigerGraph REST API calls that you can start using in Postman:

Run in Postman

In order to use the collection, you will need to create your own environment with following variables:

protocol → http OR https
url → yourdomain_or_ip_address
port → 9000
token_secret → howto get secret
token → paste here the value that you get when running GET_reqesttoken method
port_gui → 14240

3 Likes

Found docs on this and your list above helped. Thanks!

1 Like

@gpadvorac That Postman collection might be old. Let me know if you have any issues with that Postman Collection. I can help update a new Collection for you.

Yes it’s timing out. This is how it’s configured:

image

and its calling this simple query which is installed:

@gpadvorac Are you running an on-prem version or using TigerGraph Cloud? Since this Postman Collection, there were a few ports changed. Can you try using 443 instead?

I’ve also created a new Postman collection that covers every built-in endpoint. You can download it here and then import the collection into your Postman application

Example:
https://my-cloud-graph:443/restpp/query/myGraph/edgecrawl

Note for users of TigerGraph Cloud

For all TigerGraph Cloud solutions created on or after June 20, 2022, ports 14240 and 9000 are no longer exposed. This also applies to previously created cloud solutions that are resized on or after June 20, 2022. Use port 443 instead for API endpoint connectivity on cloud solutions:

  • Use API endpoint 443/restpp/<endpoint> for RESTPP endpoints that were on port 9000
  • Use API endpoint 443/<endpoint> for endpoints that were on port 14240

For all TigerGraph Server solutions not on TigerGraph Cloud, or for TigerGraph Cloud solutions created before June 20, 2022, ports 9000 and 14240 remain correct.