deprecate get_runtime_api_base_url

qiskit_ibm_runtime/utils/__init__.py

@@ -21,6 +21,7 @@
 from .utils import (
     to_python_identifier,
     is_crn,
+    get_runtime_api_base_url,
     default_runtime_url_resolver,
     resolve_crn,
     are_circuits_dynamic,

qiskit_ibm_runtime/utils/utils.py

@@ -31,6 +31,7 @@
 from qiskit.circuit import QuantumCircuit, ControlFlowOp
 from qiskit.transpiler import Target
 from qiskit.providers.backend import BackendV1, BackendV2
+from .deprecation import deprecate_function
 
 
 def is_simulator(backend: BackendV1 | BackendV2) -> bool:
@@ -157,6 +158,19 @@ def is_crn(locator: str) -> bool:
     return isinstance(locator, str) and locator.startswith("crn:")
 
 
+@deprecate_function(
+    "get_runtime_api_base_url()",
+    "0.30.0",
+    "Please use default_runtime_url_resolver() instead.",
+    stacklevel=1,
+)
+def get_runtime_api_base_url(
+    url: str, instance: str, private_endpoint: Optional[bool] = False
+) -> str:
+    """Computes the Runtime API base URL based on the provided input parameters."""
+    return default_runtime_url_resolver(url, instance, private_endpoint=private_endpoint)
+
+
 def default_runtime_url_resolver(url: str, instance: str, private_endpoint: bool = False) -> str:
     """Computes the Runtime API base URL based on the provided input parameters.
 

release-notes/unreleased/1914.deprecation.rst

@@ -0,0 +1 @@
+Deprecate util function `get_runtime_api_base_url`: use `default_runtime_url_resolver` instead.