Using the Workbench REST API

The Workbench REST API can be used to automate various tasks without having to open the Workbench in a browser and doing them manually.

The REST API calls fall into six major categories:

Security management

Use the security management API to add, edit, or remove users, thus integrating the Workbench security into an existing system.

Location management

Use the location management API to attach, activate, edit, or detach locations.

Repository management

Use the repository management API to add, edit, or remove a repository to/from any attached location. Unlike the RDF4J API, you can work with multiple remote locations from a single access point. When combined with the location management, it can be used to automate the creation of multiple repositories across your network.

Cluster management

Use the cluster management API to connect or disconnect workers to/from masters, masters to/from masters and to query the status of connected workers. You can also trigger a backup or restore on any master node. The advantage of using the cluster management API is not having to work with JMX. When combined with location and repository management, it can be used to automate the setup of a GraphDB EE cluster.

Data import

Use the data import API to import data in GraphDB. You can choose between server files and a remote URL.

Saved queries

Use the saved queries API to create, edit or remove saved queries. It is a convenient way to automate the creation of saved queries that are important to your project.

You can find more information about each REST API functionality group and its operations in Help -> REST API Documentation, as well as execute them directly from there and see the results.


Click on a functionality group to expand it and see the operations that it includes. Click on an operation to see details about it.