Access instances with platform APIs: change verification from the deprecated GET /functions to GET /entitlements

URL to the relevant guide or resource

https://quantum.cloud.ibm.com/docs/en/guides/access-instances-platform-apis#verify-result

Also affected: the Step 3 paragraph that contrasts the account and functions endpoints.

Source file: docs/guides/access-instances-platform-apis.mdx

The section it edits was added under https://github.com/Qiskit/documentation/issues/5407 and https://github.com/Qiskit/documentation/pull/5406.

Select all that apply

• out-of-date content

Describe the fix or the content request.

The guide tells account admins to verify an instance's Qiskit Functions configuration with GET /functions from the Qiskit Runtime API. That endpoint is deprecated in favour of GET /entitlements, which is now the endpoint to use, and GET /functions is scheduled for removal.

Four places in access-instances-platform-apis.mdx name the old endpoint:

• the Step 3 paragraph contrasting GET /accounts/{id} with GET /functions ("use the account endpoint to discover valid values, and the functions endpoint to confirm the result")
• the opening sentence of Verify the result
• the cURL sample in that section, https://quantum.cloud.ibm.com/api/v1/functions
• the Python sample in that section, same URL

The change is more than a URL swap, because the response is shaped differently. GET /entitlements returns one element per requested instance:

{"instance_entitlements": [{"instance_crn": "<CRN>", "functions": [], "custom_functions": {"permissions": []}}]}

So a reader verifying a single instance reads the entitlements from the first element of instance_entitlements, rather than from a top-level functions field. The Service-CRN header and the apikey authorization are unchanged.

Two points worth adding while the section is being edited:

• Service-CRN accepts several CRNs separated by commas, so an admin can verify a batch of instances in one call. This is the main practical gain over the old endpoint.
• An element carries either entitlements or an error, never both, and an absent functions or custom_functions field means the instance is not granted that type.

Please do not change the section anchors

<span id="verify-result" /> and <span id="functions-api" /> are linked from the IBM Quantum Platform UI, along with #configure-qiskit-functions-access-on-an-instance. Renaming the sections is fine, as long as those spans stay.

For new content requests, do you want to write the content?

I can provide information about the request and the response for curl and Python.

Read docs/guides/access-instances-platform-apis.mdx, focusing on Step 3 and the Verify the result section. Update the four GET /functions references and describe the instance_entitlements response, batch CRNs, and error or absent-field behavior in the curl and Python examples. Keep the verify-result and functions-api anchors unchanged.