Denodo and REST APIs

On this page:


You can use Denodo to create simple APIs based off nearly any data source. Instead of architecting an application around a difficult data source, you can build a Denodo API to suit an application. See below for potential use cases and details about creating an API with Denodo.

Potential use cases for Denodo APIs

Denodo APIs can be useful if:

  • An app needs a simpler RESTful interface to data, instead of a JDBC or ODBC connection.
  • An app needs to combine data from multiple sources.
  • An app needs data from sources that are difficult to access or parse, such as cloud sources (for example, AWS or Azure), cubes, Hadoop, LDAP, SFTP, Excel files, flat files, or other APIs.
  • Existing application APIs do not meet application specifications because of inflexible output format, inability to accept filters or criteria, missing data, or data format issues.

Following are suggested use cases for an API with Denodo:

  • Use an API to circumvent native APIs, so data are provided with the proper filter and in the required format.
  • Use an API to expose tables as a RESTful API, cutting down on the overhead and complexity of direct database calls while providing a filter and output that meet specifications.
  • Use an API to seamlessly union or join an Excel file on NPM or GitHub with relational databases.
  • Use an API to query the ADS through LDAP, and return the members of a group or an individual's groups.
  • Use an API as a proxy for SFTP transactions.

Default RESTful web service

All Denodo views are automatically and securely exposed through a default API. Before creating a new RESTful web service, access the default Denodo web service to check whether it is adequate.

To access it, use a URL in this format:


In the above example URL:

  • Replace <-environment> with -dev for the DEV environment or -stg for the STG environment, or omit <-environment> for the PRD environment.
  • Replace <your_VDB_name> with the appropriate VDB name.
  • Replace <your_view_name> with the appropriate view name.

For example, to access the ims_translate_i view in the iu_edss VDB in the DEV environment, use this URL:

Alternatively, to access the same view on PRD, use this URL:

To retrieve the information in a different format, without pagination, you can append strings (such as ?$format=XML or ?$format=JSON) to the URL. You also can query the data through the default web service.

Create an API with Denodo

To create a REST web service:

  1. In the elements tree, right-click the view you want to publish; then, select New > Data service > REST Web service:
    Element tree in Denodo with new REST webservice path highlighted
  2. The "Create REST Web service" dialog box will open, and you'll see the following tabs:
    1. Resources: Lists the view published by the web service. This tab will be automatically populated with the attributes of the view you selected to create your REST web service.
    2. Settings: Manages the configuration of the REST web service. On this tab, from the "Authentication:" drop-down menu, select HTTP Basic with VDP, and leave the default configurations for all other fields:
      Settings tab with Authentication drop-down highlighted
    3. Advanced: Manages the parameters of the connection between the web service and the Virtual DataPort Server. Accept the default settings on this tab.
    4. Metadata: Accept the default settings on this tab.
  3. Click Save:
    Denodo Virtual DataPort Administration Tool with Save button highlighted
  4. The new web service will not be available until it has been deployed. To deploy it, right-click the name of the web service in the navigation pane on the left, and select Deploy:
    Denodo Virtual DataPort Administration Tool with deploy option highlighted
  5. After you've successfully deployed the service, at the top of the page, open the Tools menu, and then select Web services container:
    Tools menu open with Web services container option highlighted
  6. In the "Web Services Container Status" window, locate the name of your web service, and click the associated link in the "Context Path" column:
    Denodo Virtual DataPort Administrative Tool with web services container status window open and context path highlighted
  7. Your browser will open a broken link. To see the data for your web service, edit the link by removing the string :9443, so your URL resembles this:
  8. If HTML is the default format for your service, you'll see a page like the below.

    If prompted, log in with your IU username and passphrase.

    To display the data, click the link under "View name":

    Denodo with REST Web Service link highlighted

Consume Denodo APIs

When you're presenting data in HTML format, Denodo will paginate the output. Formats other than HTML will not be paginated.

To set the format of the data to XML, append the string $format=XML to the URL:$format=XML

Learn more

To learn more about using Denodo APIs, see:

This is document amto in the Knowledge Base.
Last modified on 2023-09-11 15:28:05.