Managing a custom API integration

The following steps describe how to add, edit, or delete a custom API integration.

You can perform the following actions with a custom API integration:

Adding a custom API integration

To begin monitoring your data platform with the orchestration or data integration tool of your choice, complete the following steps in the Databand UI:

  1. Click Integrations in the navigation menu.
  2. Click Add integration.
  3. Select Custom integration as the integration type.
  4. In the Add a custom integration step, provide the following information:
    Orchestration or data integration tool
    The name of the tool that you want to integrate with Databand.
    Display name
    The name that you want to call your integration. This name becomes the Source name throughout the Databand UI.
  5. Click Generate token.
  6. Copy the API credential token and the API endpoint and enter them into your chosen orchestration or integration tool. You can view and copy the API endpoint at any time, but you can only view the API credential token in this step, so make sure to copy it before you continue.
    API credential token
    Databand automatically generates a generic API credential token to use for your integration.
    API endpoint
    The URL to which you submit requests from your custom integration.
  7. Click Done.

Editing a custom API integration

Follow these steps to edit your custom API integration or view information about your integration, such as the orchestration or data integration tool, display name, API credential token, and API endpoint.

  1. Click Integrations in the navigation menu.
  2. Locate your custom API integration on the list of integrations.
  3. Hover over the row for your integration and click Edit at the end of the row in the Actions column.
  4. View your Orchestration or integration tool or edit your Display name.
  5. Click Next to view your API endpoint. The API credential token is displayed only once, when you create your custom integration.
  6. Click Done.

You can now view your edited integration in the Integrations page.

Deleting a custom API integration

To delete a custom API integration:

  1. Click Integrations in the navigation menu.
  2. Locate your custom API integration on the list of integrations.
  3. Hover over the row for your integration and click the Options icon Options, then click Delete.
  4. Click Delete.

In the Integrations page, you can now see that the integration was deleted.

Known issues

Custom API integrations in Databand have the following known issues:

  • The Status column in the Databand UI remains empty for custom API integrations. Check the site of the data integration or orchestration tool you are using to make sure your integration is running properly.
  • By default the Runs page has a filter set for a 7-day timeframe. As a result, only the runs within the 7-day timeframe are displayed. To display all runs, remove the Range last 7 days filter.