Introduction Note: This API version is deprecated. Please use the v3 APIhttps://cloud.ibm.com/apidocs/watsonxdata-v3 instead. IBM® watsonx.data is a data management solution for collecting, storing, querying, and analyzing all your enterprise data structured, semi-structured, and unstructured with a single unified data platform. It provides a flexible and reliable platform that is optimized to work on open data formats. The api are in beta state and expected to change. Endpoint URLs The base URLs come from the service instance. To find the URL, view the service credentials by clicking the name of the service in the Resource listhttps://cloud.ibm.com/resources. Use the value of the URL. Add the method to form the complete API endpoint for your request. Authentication Required Purpose: To work with the API, you must use an IBM Cloud Identity and Access Management IAM access token. The token is used to determine the actions that a user or service ID has access to when they use the API. You can generate an IAM token for an authenticated user or service ID by using the IAM Identity Services APIhttps://cloud.ibm.com/apidocs/iam-identity-token-api. IAM tokens are generated by using the user or service ID's API key. For more information, see Generating an IBM Cloud IAM token by using an API keyhttps://cloud.ibm.com/docs/account?topic=account-iamtokenfromapikey. To use the API, add a valid IAM token to the HTTP Authorization request header, for example, -H 'Authorization: Bearer {TOKEN}'. To retrieve your access token: bash curl -X POST \ "https://iam.cloud.ibm.com/identity/token" \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Accept: application/json' \ --data-urlencode 'granttype=urn:ibm:params:oauth:grant-type:apikey' \ --data-urlencode 'apikey={APIKEY}' Replace {APIKEY} with your IAM API keyhttps://cloud.ibm.com/docs/account?topic=account-userapikey. Auditing Required if applicable Purpose: Describes that the API generates auditing events that can be consumed by the Activity Tracker service, and links to your related product docs for more information. Required only if any of the API's methods is enabled to generate auditing events. Example: You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method. For more information about how to track Certificate Manager activity, see Auditing events for Certificate Managerhttps://cloud.ibm.com/docs/certificate-manager?topic=certificate-manager-atevents. Error handling This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error. | HTTP Error Code | Description | Recovery | |-----------------|-----------------------|-----------------------------------------------------------------------------| | 200 | Success | The request was successful. | | 201 | Created | The requested resource successfully created in a synchronous manner. | | 204 | No Content | The server successfully processed the request and is not returning any content.| | 400 | Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. | | 401 | Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions. | | 403 | Forbidden | The supplied authentication is not authorized to access '{namespace}'. | | 404 | Not Found | The requested resource could not be found. | | 409 | Conflict | The entity is already in the requested state. | | 500 | Internal Server Error | Your request could not be processed. Wait a few minutes and try again. | Pagination Some API requests might return many results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination: /v1/statement For the request that uses pagination, the response does include following urls to make subsequent requests : infoUri: The URL for requesting the first page of results. nextUri: The URL for requesting the next page of results.
| Method | Path | Summary |
|---|---|---|
| POST | /storage_hdfs_registrations | Add/Create HDFS storage |
| GET | /storage_registrations | Get list of storage registrations |
| POST | /storage_registrations | Register storage |
| GET | /storage_registrations/{id} | Get storage |
| DELETE | /storage_registrations/{id} | Unregister Storage |
| PATCH | /storage_registrations/{id} | Update storage |
| POST | /storage_registrations/{storage_id}/catalogs | Add storage catalog |
| POST | /storage_registrations/{storage_id}/object_properties | Get storage object properties |
| GET | /storage_registrations/{storage_id}/objects | List storage objects |
| GET | /database_registrations | Get list of databases |
| POST | /database_registrations | Add/Create database |
| POST | /database_registrations/{database_id}/catalogs | Add database catalog |
| GET | /database_registrations/{id} | Get database |
| DELETE | /database_registrations/{id} | Delete database |
| PATCH | /database_registrations/{id} | Update database |
| GET | /presto_engines | Get list of Presto(Java) engines |
| POST | /presto_engines | Create presto engine |
| PATCH | /presto_engines/{engine_id}/autoscaling | Update Autoscaling Configuration |
| GET | /presto_engines/{engine_id}/catalogs | Get presto engine catalogs |
| POST | /presto_engines/{engine_id}/catalogs | Associate catalogs to presto engine |
| DELETE | /presto_engines/{engine_id}/catalogs | Disassociate catalogs from a presto engine |
| GET | /presto_engines/{engine_id}/catalogs/{id} | Get presto engine catalog |
| GET | /presto_engines/{engine_id}/config | Get Presto Engine Configuration |
| PATCH | /presto_engines/{engine_id}/config | Update Presto Engine Configuration |
| GET | /presto_engines/{id} | Get presto engine |
| DELETE | /presto_engines/{id} | Delete presto engine |
| PATCH | /presto_engines/{id} | Update presto engine |
| POST | /presto_engines/{id}/pause | Pause presto engine |
| POST | /presto_engines/{id}/query_explain | Explain presto query |
| POST | /presto_engines/{id}/query_explain_analyze | Explain presto analyze |
| POST | /presto_engines/{id}/restart | Restart a presto engine |
| POST | /presto_engines/{id}/resume | Resume Presto(Java) engine |
| POST | /presto_engines/{id}/scale | Scale a presto engine |
| GET | /prestissimo_engines | Get list of prestissimo engines |
| POST | /prestissimo_engines | Create prestissimo engine |
| GET | /prestissimo_engines/{engine_id}/catalogs/{id} | Get prestissimo engine catalog |
| GET | /prestissimo_engines/{id} | Get prestissimo engine |
| DELETE | /prestissimo_engines/{id} | Delete prestissimo engine |
| PATCH | /prestissimo_engines/{id} | Update prestissimo engine |
| GET | /prestissimo_engines/{id}/catalogs | Get prestissimo engine catalogs |
| POST | /prestissimo_engines/{id}/catalogs | Associate catalogs to a prestissimo engine |
| DELETE | /prestissimo_engines/{id}/catalogs | Disassociate catalogs from a prestissimo engine |
| POST | /prestissimo_engines/{id}/pause | Pause prestissimo engine |
| POST | /prestissimo_engines/{id}/query_explain | Explain query |
| POST | /prestissimo_engines/{id}/query_explain_analyze | Explain analyze |
| POST | /prestissimo_engines/{id}/restart | Restart a prestissimo engine |
| POST | /prestissimo_engines/{id}/resume | Resume prestissimo engine |
| POST | /prestissimo_engines/{id}/scale | Scale a prestissimo engine |
| GET | /db2_engines | Get list of db2 engines |
| POST | /db2_engines | Create db2 engine |
| DELETE | /db2_engines/{id} | Delete db2 engine |
| PATCH | /db2_engines/{id} | Update db2 engine |
| GET | /other_engines | Get list of other engines |
| POST | /other_engines | Create other engine |
| DELETE | /other_engines/{id} | Delete engine |
| GET | /netezza_engines | Get list of Netezza engines |
| POST | /netezza_engines | Create netezza engine |
| DELETE | /netezza_engines/{id} | Delete netezza engine |
| PATCH | /netezza_engines/{id} | Update netezza engine |
| GET | /spark_engines | Get list of spark engines |
| POST | /spark_engines | Create spark engine |
| GET | /spark_engines/{engine_id}/catalogs/{id} | Get spark engine catalog |
| GET | /spark_engines/{id} | Get spark engine |
| DELETE | /spark_engines/{id} | Delete spark engine |
| PATCH | /spark_engines/{id} | Update spark engine |
| GET | /spark_engines/{id}/catalogs | Get spark engine catalogs |
| POST | /spark_engines/{id}/catalogs | Associate catalogs to spark engine |
| DELETE | /spark_engines/{id}/catalogs | Disassociate catalogs from a spark engine |
| POST | /spark_engines/{id}/pause | Pause engine. (SaaS only) |
| POST | /spark_engines/{id}/resume | Resume engine. (SaaS only) |
| GET | /spark_engines/{engine_id}/capacities | List spark engine capacities. (SaaS only) |
| POST | /spark_engines/{engine_id}/capacities | Create spark engine capacity. (SaaS only) |
| GET | /spark_engines/{engine_id}/capacities/{id} | Get a capacity of a given spark engine. (SaaS only) |
| PATCH | /spark_engines/{engine_id}/capacities/{id} | Update a capacity of a spark engine. (SaaS only) |
| DELETE | /spark_engines/{engine_id}/capacities/{id} | Delete a capacity of a spark engine. (SaaS only) |
| POST | /spark_engines/{engine_id}/capacities/{id}/pause | Pause a capacity of a spark engine. (SaaS only) |
| POST | /spark_engines/{engine_id}/capacities/{id}/resume | Resume a capacity of a spark engine. (SaaS only) |
| GET | /spark_engines/{engine_id}/applications/{id} | Get spark engine application details |
| DELETE | /spark_engines/{engine_id}/applications/{id} | Stop Spark Applications |
| GET | /spark_engines/{engine_id}/applications/{id}/ui | Redirect to spark UI |
| GET | /spark_engines/{id}/applications | List all applications in a spark engine |
| POST | /spark_engines/{id}/applications | Create spark engine application |
| GET | /spark_engines/{id}/history_server | Get Spark history server details |
| POST | /spark_engines/{id}/history_server | Start spark history server |
| DELETE | /spark_engines/{id}/history_server | Stop spark history server |
| GET | /spark_engines/{id}/history_server/ui | Redirect to spark history server UI |
| GET | /spark_engines/flavors | List available capacity flavors. (SaaS only) |
| GET | /spark_engines/flavors/providers | List available cloud providers for capacity. (SaaS only) |
| GET | /spark_engines/flavors/regions | List available regions for a cloud provider. (SaaS only) |
| GET | /spark_engines/spark_tshirt_sizes | List engine t-shirt sizes. (SaaS only) |
| GET | /spark_engines/{engine_id}/metrics | List spark engine usage metrics. (SaaS only) |
| POST | /integration_validation | To validate an integration |
| GET | /integrations | List integrations |
| POST | /integrations | Create an integration |
| GET | /integrations/{id} | Get an Integration |
| DELETE | /integrations/{id} | Delete an Integration |
| PATCH | /integrations/{id} | Update an Integration |
| POST | /catalogs/{catalog_id}/schemas/{schema_id}/register | Register delta and hudi tables |
| GET | /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/metadata | Load delta and hudi tables metadata |
| GET | /catalogs | Get list of registered catalogs |
| GET | /catalogs/{catalog_name}/engines | Get catalog engine association |
| DELETE | /catalogs/{catalog_name}/schemas/{schema_name} | Delete schema |
| GET | /catalogs/{catalog_name}/schemas/{schema_name}/tables | List all tables |
| GET | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name} | Get table details |
| DELETE | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name} | Delete table |
| PATCH | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name} | Rename table |
| GET | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns | List all columns of a table |
| POST | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns | Add column(s) |
| DELETE | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns/{column_name} | Delete column |
| PATCH | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns/{column_name} | Alter column |
| POST | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/rollback | Rollback snapshot |
| GET | /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/snapshots | Get table snapshots |
| GET | /catalogs/{id}/schemas | List all schemas |
| POST | /catalogs/{id}/schemas | Create schema |
| POST | /catalogs/{id}/sync | External Iceberg table registration |
| GET | /catalogs/{name} | Get catalog properties by catalog_id |
| DELETE | /catalogs/{name} | Delete catalog catalog_id |
| GET | /milvus_services | Get list of milvus services |
| POST | /milvus_services | Create milvus service |
| GET | /milvus_services/{id} | Get milvus service |
| DELETE | /milvus_services/{id} | Delete milvus service |
| PATCH | /milvus_services/{id} | Update milvus service |
| POST | /milvus_services/{id}/pause | Pause milvus service |
| POST | /milvus_services/{id}/resume | Resume milvus service |
| POST | /milvus_services/{id}/scale | Scale a milvus service |
| GET | /milvus_services/{service_id}/databases | Get milvus service databases |
| GET | /milvus_services/{service_id}/databases/{database_id}/collections | Get milvus database collections |
| GET | /milvus_services/{service_id}/databases/{database_id}/collections/{collection_name}/partitions | Get milvus database collection partitions |
| PATCH | /milvus_services/{service_id}/storage | Update milvus service storage |
| GET | /sal_integration | Get semantic automation layer Integration of the instance |
| POST | /sal_integration | Create semantic automation layer integration with IBM Knowledge Catalog |
| DELETE | /sal_integration | Delete Semantic Automation Layer(SAL) integration |
| PATCH | /sal_integration | Patch Semantic automation layer integration |
| POST | /sal_integration/enrichment | create enrichment jobs of schema(or tables in schema) |
| GET | /sal_integration/enrichment/data_assets | List semantic enriched data_assets in IBM Knowledge catalog |
| GET | /sal_integration/enrichment/data_assets/{id} | Get semantic enrichment data_asset associated with the table |
| GET | /sal_integration/enrichment/global_settings | Get metadata enrichment global settings |
| PUT | /sal_integration/enrichment/global_settings | Create or update metadata enrichment global settings |
| GET | /sal_integration/enrichment/jobs | List semantic enrichment jobs associated with the schema |
| GET | /sal_integration/enrichment/jobs/{job_id}/runs | List semantic enrichment job runs associated with the schema |
| GET | /sal_integration/enrichment/jobs/{job_id}/runs/{run_id}/logs | Get semantic enrichment job run logs associated with the job run |
| GET | /sal_integration/enrichment/project_settings | get metadata enrichment settings for a IBM Knowledge Catalog project(schema) |
| PUT | /sal_integration/enrichment/project_settings | Create or update project level metadata enrichment settings |
| GET | /sal_integration/glossary/terms | Get list of uploaded glossary terms |
| POST | /sal_integration/glossary/upload_processes | Upload semantic enrichment business terms glossary |
| GET | /sal_integration/glossary/upload_processes/{id}/status | Get status of glossary uploading process(job) |
| GET | /sal_integration/mappings | Post watsonx.data schema to fetch mapped catalog and project |
| GET | /sal_integration/semantic_search/queries | List Semantic Search queries snapshot |
| POST | /sal_integration/semantic_search/queries | Trigger a global search among IBM Knowledge Catalog metadata by given query |
| DELETE | /sal_integration/semantic_search/queries | Clear semantic search query history |
| DELETE | /sal_integration/semantic_search/queries/{id} | Delete semantic search query history by record id |
| DELETE | /sal_metadata | Delete Semantic automation layer(SAL) integration metadata |
| GET | /lhingestion/api/v1/ingestion/jobs | List ingestion jobs |
| POST | /lhingestion/api/v1/ingestion/jobs | Submit ingestion job |
| GET | /lhingestion/api/v1/ingestion/jobs/{id} | Get ingestion job by ID |
| GET | /instance_configuration | Get the instane configuration |
| GET | /instance_configuration/resources | List the instance configuration resources |
| GET | /instance_configuration/resources/{id} | Get a resource |