Retrieving your instance ID

You can target an individual IBM Cloud® Hyper Protect Crypto Services instance for operations by including the unique identifier, or instance ID, in API requests to the service.

Viewing your instance ID with the UI

You can view the instance ID that is associated with your Hyper Protect Crypto Services service instance by navigating to your IBM Cloud resource list.

Log in to the UI.
Go to Menu > Resource list, and then click Services to browse a list of your cloud services.
Click the table row that describes your Hyper Protect Crypto Services service instance.
Go to Overview > Instance, and copy the Instance ID value.

This Instance ID uniquely identifies your Hyper Protect Crypto Services service instance.

Retrieving an instance ID with the CLI

You can also retrieve the instance ID for your service instance by using the IBM Cloud CLI.

Log in to IBM Cloud with the IBM Cloud CLI.
```
ibmcloud login
```
If the login fails, run the ibmcloud login --sso command to try again. The --sso parameter is required when you log in with a federated ID. If this option is used, go to the link listed in the CLI output to generate a one-time passcode.
Select the region and resource group that contain your provisioned instance of Hyper Protect Crypto Services. You can use the following command to set your target region and resource group.
```
ibmcloud target -r <region_name> -g <resource_group_name>
```
Retrieve the Cloud Resource Name (CRN) that uniquely identifies your Hyper Protect Crypto Services service instance.
```
ibmcloud resource service-instance <instance_name> --id
```
Replace <instance_name> with the unique alias that you assigned to your Hyper Protect Crypto Services service instance. The following truncated example shows the CLI output.
```
crn:v1:public:hs-crypto:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:42454b3b-5b06-407b-a4b3-34d9ef323901:: 42454b3b-5b06-407b-a4b3-34d9ef323901
```
The 42454b3b-5b06-407b-a4b3-34d9ef323901 value is an example instance ID.

Retrieving an instance ID with the API

You might want to retrieve the instance ID programmatically to help you build and connect your application. You can call the IBM Cloud Resource Controller API, and then pipe the JSON output to jq to extract this value.

Retrieve an IBM Cloud IAM access token.

Call the Resource Controller API to retrieve your instance ID.

curl -X GET \
https://resource-controller.cloud.ibm.com/v2/resource_instances \
-H 'Authorization: Bearer <access_token>' | jq -r '.resources[] | select(.name | contains("<instance_name>")) | .guid'

Replace <instance_name> with the unique alias that you assigned to your Hyper Protect Crypto Services service instance. The following output shows an example instance ID:

42454b3b-5b06-407b-a4b3-34d9ef323901