Available APIs

The APIs that you have access to depend on the services that are installed in your environment.

IBM® Software Hub and some services that run on the platform provide open and extensible APIs.

You can authenticate to the IBM Software Hub platform and the APIs by using a single authentication token. See Generating API keys for authentication.

For more information about the APIs that you can use, see the following resources.

Apache Spark jobs API

Description

In IBM Software Hub, you can run Spark jobs or applications on your cluster without installing Watson Studio. Use the Spark jobs REST API of Analytics Engine powered by Apache Spark.

You can submit any Spark application that runs Spark SQL or data transformation, data science, and machine learning jobs by using the Spark jobs REST API. Each submitted job runs in a dedicated cluster.

Requirements
To use this API, an administrator must install the Analytics Engine powered by Apache Spark service on the IBM Software Hub platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference
Spark jobs API syntax, parameters and return codes

Connections API

Description
The Data and AI Common Core API includes instructions for creating a connection in a catalog or project.
Requirements

To use this API, one of the following services must be installed:

  • IBM Knowledge Catalog
  • Watson Studio
  • A service that installs the IBM Software Hub common core services. The common core services are automatically installed by services that rely on them.
API reference
Data and AI Common Core Software APIs

You can view a table of the individual data source properties at Data > Connectivity. Expand Connection resources, and select Connection properties.

Data and AI Common Core API

Description
You can use the Data and AI Common Core API for software products such as IBM Cloud Pak for Data and IBM watsonx™. For example, you can use the API to perform the following tasks.
  • Manage projects.
  • Manage connections in projects.
  • Discover assets from a connection.
  • Manage jobs and environments.
  • Execute queries in global search.
Requirements

To use this API, the Watson Studio service must be installed:

API reference
Data and AI Common Core Software APIs

Data Product Hub API

Description
You can use application programming interfaces (APIs) to work with data products in Data Product Hub.
Requirements
To use this API, an administrator must install this service on the IBM Software Hub platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference
The API reference documentation for the Data Product Hub API is published at the following location: Data Product Hub API.
You can also use the Data and AI Common Core API to manage data products. You can use APIs related to assets, catalogs, asset lists, connections, and global search.

DataStage REST API

Description
Use the DataStage REST API to process, compile, and run flows. DataStage flows are design-time assets that contain data integration logic in JSON-based schemas.
Requirements
To use this API, an administrator must install this service on the IBM Software Hub platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.
API reference
DataStage REST API

IBM Knowledge Catalog API

Description

The IBM Knowledge Catalog API provides capabilities for IBM Knowledge Catalog. You can use the API to manage data-related assets and the people who need to use these assets. For example, you can use the API to perform the following tasks.

  • Define data profiling.
  • Analyze data quality.
  • Establish a business glossary.
  • Create metadata discovery and enrichment assets.
  • Define data governance policies.
  • Manage data governance workflows.
Requirements

To use this API, the IBM Knowledge Catalog service must be installed.

API reference
IBM Knowledge Catalog software APIs
You can also use the Data and AI Common Core API to manage data-related assets in IBM Knowledge Catalog.

IBM Manta Data Lineage API

Description

The IBM Manta Data Lineage API provides capabilities to manage your data lineage. For example, you can use the API to manage the following areas.

  • Lineage assets
  • Lineage graph
  • Technology
  • Licensing
Requirements

To use this API, the IBM Manta Data Lineage service must be installed.

API reference
IBM Manta Data LineageAPI reference

Semantic Automation API

Description

The Semantic Automation API provides access to the generative AI capabilities in IBM watsonx.data™ intelligence or the IBM Knowledge Catalog Standard or Premium Cartridge to semantically enrich metadata for assets by using AI models. For example, you can use the API to perform the following tasks:

  • AI-based metadata enrichment
  • Generation of descriptions for data quality ruless
  • Generation of embeddings for semantic search and similarity use cases
Requirements

To use this API, IBM watsonx.data intelligence service or the IBM Knowledge Catalog Standard or Premium Cartridge must be installed, and generative AI capabilities must be enabled.

API reference
Semantic Automation APIs

watsonx.data integration SDK

Description
Use the watsonx.data integration SDK for Python to programmatically interact with watsonx.data integration. You can use the SDK to automate and manage watsonx.data integration flows, including creating, configuring, starting, stopping, and monitoring flows directly in code.
Requirements
To use these APIs, the watsonx.data integration service must be installed.
API reference
IBM watsonx.data integration SDK for Python