Organizations with the Ardoq Graph feature can also access their graph with a plain Gremlin Client. This enables you to take advantage of all the Gremlin Query features, such as the explain() step.

You connect to the Ardoq Graph using a standard Apache Tinkerpop Gremlin Console, which you can download from here:

The queries made through the Gremlin Console are read-only, and will not in any case edit or write over anything.

Apache TinkerPop Gremlin Console


Gremlin Console needs a configuration to set up the remote connection to Ardoq. You can generate a pre-populated configuration from your Account Settings, under the API and Tokens tab as illustrated below:

Ardoq Gremlin client

Select the Tinkperpop version that matches your download, and copy and paste the configuration into a file ardoq-remote.yaml in the conf folder in your Gremlin Client installation.

Download the public certificate to ensure your connection is secure:
wget -P conf

For Tinkerpop version 3.3.3 and older:

The ardoq-remote.yaml includes a reference to ardoq-trust-certificate.pem , and expects the certificate to also be located in the conf folder.

For Tinkerpop version newer than 3.3.4, the config requires trustStore parameters, where the path and password must match with the configuration:

$keytool -import -v -trustcacerts -alias ardoq-ca -file conf/ardoq-trust-certificate.pem -keystore conf/ardoq-truststore.jks -noprompt -storepass <provide your trust store password here>

Connect to Ardoq

Start the Gremlin Console

~/gremlin-console$ bin/

         (o o)
plugin activated: tinkerpop.server
plugin activated: tinkerpop.gephi
plugin activated: tinkerpop.utilities
plugin activated: tinkerpop.tinkergraph

Connect to Ardoq

gremlin> :remote connect tinkerpop.server conf/ardoq-remote.yaml

Run a remote query using the remote operator :> 

gremlin> :> g.V().count()

To execute all queries remotely, use :remote console  

gremlin> :remote console
==>All scripts will now be sent to Gremlin Server - [] - type ':remote console' to return to local mode
gremlin> g.V().count()
Did this answer your question?