---
name: watsonxdata-hms_credentials
title: Retrieving Metadata Service (MDS) endpoints and credentials
description: IBM&reg; watsonx.data integrates with multiple entities like Spark, Db2, NPSaaS, and the like. You require watsonx.data MDS credentials and enpoint to establish connection with the entities at the time of integration.
last-updated: 2026-01-13
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/watsonxdata?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# Retrieving Metadata Service (MDS) endpoints and credentials
{: #hms}

IBM&reg; watsonx.data integrates with multiple entities like Spark, Db2, NPSaaS, and the like. You require watsonx.data MDS credentials and enpoint to establish connection with the entities at the time of integration.
{: shortdesc}

MDS username is by default `ibmlhapikey_<username>`.


## Generating API key
{: #hms_api}

1. As the watsonx.data administrator, you can:

   1. [Create service IDs](https://ondeck.console.cloud.ibm.com/docs/account?topic=account-serviceids&interface=ui&format=markdown#create_serviceid)
   2. [Invite users and grant permissions](https://cloud.ibm.com/docs/account?topic=account-access-getstarted&format=markdown#group_access)

   Permission required for watsonx.data are `MetastoreAdmin` in **Service access** and appropriate roles in **Platform access**.
   {: note}

1. Generate an API key. for more information, see:

   - [Creating an API key for users or user groups](https://cloud.ibm.com/docs/account?topic=account-userapikey&interface=ui&format=markdown#create_user_key)
   - [Creating an API key for a service ID](https://cloud.ibm.com/docs/account?topic=account-serviceidapikeys&interface=ui&format=markdown#create_service_key)

## Getting the MDS endpoint
{: #hms_url}

1. Log in to watsonx.data console.
1. From the navigation menu, select **Infrastructure manager**.
1. Select the catalog.
1. Click **Details** to view the catalog details page.
1. Copy the endpoint:

   1. **Metastore Thrift endpoint**: This is your Hive interface endpoint for thrift.
   1. **Metastore REST endpoint**: Use this for Unity and Iceberg Catalog REST API.

   You can retrieve the endpoints using API. For more information, see [Get catalog API](https://cloud.ibm.com/apidocs/watsonxdata#get-catalog).