Manta Insights API Usage

Overview

The Manta Lighthouse API is an HTTP-based REST interface for the Manta Insights module of Manta Flow Server. It uses the http(s)://<MANTA_SERVER_BASE_URL>/api/lighthouse endpoint (e.g., http://localhost:8080/manta-dataflow-server/api/lighthouse).

Requirements

To follow these steps, you’ll need a valid IBM Automatic Data Lineage license with the Manta Insights add-on.

Instructions for Usage via Postman

To test Manta Insights, use Postman with Manta Insights API Collection with pre-prepared examples of rules with various configurations of REST requests to the Lighthouse endpoints. Every collection contains a single rule and a few usage examples.

Import a Collection

1. Open Postman.

2. Create a new workspace or use an existing one.

   

3. Go to Collections.

4. Click Import.

   

5. Click Upload File (JSON), and select any collection provided.

When you open a collection, click Documentation to see its description and business value.

Authentication

For secure OAuth authentication, you’ll need to provide an access token. Postman can automatically load the access token if the Keycloak client secret is provided. Follow the steps below to find and provide it.

To find the Keycloak client secret:

1. Go to the Keycloak Admin console (by default at http://localhost:9090/admin/manta/console).

2. Log in with the credentials you provided during installation.

3. Go to the Clients tab and select manta-api Client ID.

   

4. Go to the Credentials tab and copy the Secret Value.

   • If the value isn’t visible, click Regenerate Secret to create a new one.

To provide the Keycloak client secret:

1. Open your Postman collection.

2. Go to the Variables tab.

3. In client-secret, paste the secret value that you copied from the Keycloak client.

4. In access-token-url, change the token address if Keycloak does not run on the default URL http://localhost:9090.

5. Click Save.

To load the access token:

1. Go to the Authorization tab in Postman.

2. Click Get New Access Token.

3. 

4. Once it’s confirmed, click Use Token.

   • By default, the token is valid for 5 minutes. After it’s expired, you can always generate a new one.

If your credentials aren’t valid or your license is insufficient, whenever you run a call to any Lighthouse endpoint you’ll see response code 401 with the message “You are not authorized for this functionality.”

Every collection item contains a modification of REST API call parameters. The name briefly summarizes the specific parameter, and the Documentation button gives a more detailed description of how the parameters affect the rule results. The documentation also contains all input parameter configuration options — feel free to modify and combine any of them.

Base URL

Collections use the default URL http://localhost:8080, but you can customize this.

1. Go to the Variables tab.

2. Set the base-url variable current value.

To change the variable to all collections at once:

1. Go to the Environment Quick Look icon (upper-right).

2. Click Add to add a new environment.

3. Add the base-url variable with the current value.

4. From the Environment dropdown in the upper-right, choose the newly created environment.

   • The environment variables will override the default collection variables.