IBM Cloud Hyper Protect Crypto Services is introducing a more standardized and readable Endpoint URL Scheme based on our goal to provide the best potential user experience and to align with the IBM Cloud Standard URL/CRN Scheme. This Endpoint URL scheme change applies to the full set of APIs and all API Endpoints of the Hyper Protect Crypto Service.
Location: (all deployed locations) Dallas, Frankfurt, London, Madrid, Tokyo, Toronto, Sao Paulo, Washington DC
Timeframe: Continous rolling update through all IBM Cloud Regions starting July 2024
What are the key benefits?
IBM is standardizing API Endpoint URLs across its core services with the following benefits:
-
The Instance-based Endpoint URL format is consistent with the IBM Cloud URL scheme
-
The new URL format enables users to add a wildcard domain to their network allowlist, making it easier to maintain if they have multiple instances.
-
Compared with the port-based scheme, the instance-based endpoints are more readable and can easily be identified when addressed.
|
IBM Cloud Hyper Protect Crypto Services API endpoint
|
Current port-based URL
|
New instance-based URL
|
|
IBM Cloud Hyper Protect Crypto Services - Cloud KMS
|
api.<region>.hs-crypto.cloud.ibm.com:<port>
|
<INSTANCE_ID>.api.<REGION>.hs-crypto.appdomain.cloud
|
|
IBM Cloud Hyper Protect Crypto Services - CloudHSM EP11
|
ep11.<region>.hs-crypto.cloud.ibm.com:<port>
|
<INSTANCE_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud
|
|
IBM Cloud Hyper Protect Crypto Services - Unified Key Orchestrator
|
uko.<region>.hs-crypto.cloud.ibm.com:<port>
|
<INSTANCE_ID>.uko.<REGION>.hs-crypto.appdomain.cloud
|
What are the implications?
No impact to existing service instances is expected, as the current port-based endpoint scheme will stay intact for the time being. In the UI, the new instance-based endpoints scheme will be displayed for easy reference, we also show the former address when hovering over. Customers are advised, however, to use the new instance-based scheme wherever possible especially when setting up new projects. Also where possible, existing service instances should be switched to the new instance-based scheme. For new instances created after the date specified in https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-regions#new-service-endpoints, only the new instance-based scheme can be applied. For more details, please consider the Service documentation: https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-regions#new-service-endpoints.
If you have any further questions, comments, or concerns, you can always reach out to the team through IBM Cloud Support.