What's new and changed in Cloud Pak for Data APIs

API updates can include new endpoints, bug fixes, and deprecations. Releases are listed in reverse chronological order so that the current release is at the beginning of the topic.

The Cloud Pak for Data APIs are composed of REST APIs, Python libraries, Javadoc, and software development kits (SDKs). Some services document APIs while other services do not provide external APIs. For more information, see Available APIs.

You can see a list of the new features for the platform and all of the services at What's new in IBM Cloud Pak for Data.

Cloud Pak for Data Version 5.0.3

Updates to the IBM Cloud Pak for Data Platform API were released in September 2024 with Cloud Pak for Data 5.0.3.

This release includes the following changes:

Updates to APIs and methods
The following updates were introduced in this release:
New method PUT /v3/service_instances/upgrade
To patch only the version field in the custom resource (CR) during an upgrade, you can set the force_version_upgrade parameter to true and supply the targetVersion to set. If the force_version_upgrade parameter is set to true, the targetVersion parameter must be specified in the request body. If you specify args in the request body, they are ignored. For example:
curl -X 'PUT' \
  'http://pages.github.ibm.com/v3/service_instances/upgrade?sID=123&force_version_upgrade=true' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "targetVersion": "2.0.0"
}'

Make sure that your service has the custom_resource_kind defined in the add-on details object in the add_ons.json.

"custom_resource_kind": "<kind of your service>"
"custom_resource_status_field": "<CR status field name>"

For example, for Watson OpenScale, you can use the following details object.

"custom_resource_kind": "WOService"
"custom_resource_status_field": "wosStatus"

Cloud Pak for Data Version 5.0.1

Updates to the IBM Cloud Pak for Data Platform API were released in July 2024 with Cloud Pak for Data 5.0.1.

This release includes the following changes:

Updates to APIs and methods
The following updates were introduced in this release:

Cloud Pak for Data Version 5.0.0

A new version of the IBM Cloud Pak for Data Platform API was released in June 2024 with Cloud Pak for Data 5.0.0.

This release includes the following changes:

New APIs and methods
This release of IBM Cloud Pak for Data APIs includes the following features:
New IBM Cloud Pak for Data Instance Management APIs
You can set up and manage an instance of Cloud Pak for Data by using the IBM Cloud Pak for Data Instance Management REST APIs. You can perform the following tasks by using this API:
Install and upgrade an instance of Cloud Pak for Data
A cluster admin can install and upgrade an instance of Cloud Pak for Data.
Get the status of an instance of Cloud Pak for Data
A cluster admin can get the status of installed components in an instance of Cloud Pak for Data.
Shut down and restart an instance of Cloud Pak for Data
A cluster admin can shut down and restart installed components in an instance of Cloud Pak for Data.
New Data Product Hub APIs
You can write code and build applications for Data Product Hub by using the Data Product Hub APIs.
New GET v3/service_instances/statuses method
You can use the GET v3/service_instances/statuses method to fetch the status of your instances from the database cache. By default, the bulk parameter is false and this method returns the status of each service instance that the user has access to. If the bulk parameter is set to true, this method retrieves the status of service instances for the specified list of service instances, which are provided by the instance_ids parameter.
Updated methods
GET v3/service_instances/{instance_id}
The GET v3/service_instances/{instance_id} method queries details of a specific instance. By default, this method now returns the total user count in the return object in the "total_users": n response.
This method also returns a specific instance record with the service status if include_service_status is set to true.
This method now fetches the status of the instance from the database only. It returns the live status if the status is not present in the status table, if the status expired (10 minutes), if the call failed, or if the status is unknown.
GET v3/service_instances
The GET v3/service_instances method no longer returns the total user count for the instance collection when the exclude_user_count query parameter is set to true.
The total user count is still returned as the default behavior for compatibility with an earlier version. However, use the new exclude_user_count parameter if you don’t require the total user count information. When you have many service instances, the response time is faster when you use the exclude_user_count parameter.
GET v1/volumes
The GET v1/volumes method no longer returns the total user count for the volume instance collection when the exclude_user_count query parameter is set to true.
The total user count is still returned as the default behavior for compatibility with an earlier version. However, use the new exclude_user_count parameter if you don’t require the total user count information. When you have many service instances, the response time is faster when you use the exclude_user_count parameter.
Deprecated SDKs
The Watson Machine Learning Python client library is now part of the watsonx.ai Python client library. The Watson Machine Learning library is still available but it is not updated with new features.