Skip to content

Document registry server_api_url for the Cloud UI #1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samuv wants to merge 4 commits into
base: main
Choose a base branch
from
+28 −2
Open

Document registry server_api_url for the Cloud UI #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6049fa
Document registry server_api_url for the Cloud UI
samuv Jul 30, 2026
fc30779
Address Copilot review: URL shapes and em dash
samuv Jul 30, 2026
af3473b
Apply review feedback: trim over-explanation
samuv Jul 30, 2026
17c2b22
Use example.com in new section, matching #1078
samuv Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/platform/enterprise-cloud-ui/configure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,8 +271,8 @@ browser always loads them over the same protocol it uses to access the Cloud UI
The Cloud UI resolves the Registry Server API URL dynamically:

1. If an [Enterprise Manager](../enterprise-manager/index.mdx) is configured and
the [registry policy](../enterprise-manager/policies/registry.mdx) has an
`api_url` value, the Cloud UI uses that URL.
the [registry policy](../enterprise-manager/policies/registry.mdx) has a
`server_api_url` value, the Cloud UI uses that URL.
2. Otherwise, the Cloud UI falls back to the `API_BASE_URL` environment
variable.

Expand Down
26 changes: 26 additions & 0 deletions docs/platform/enterprise-manager/policies/registry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,32 @@ enterpriseConfig:
enforcement: 'enforced'
```

### Registry URL for the Cloud UI

The registry directive sets two URLs because ToolHive clients and the Cloud UI
connect to the registry differently. The `api_url` value is for ToolHive clients
(CLI and Stacklok Desktop): depending on your registry, that's either the
registry's root URL (as in the examples above) or a per-registry path on a
Stacklok Registry Server (for example,
`https://registry.example.com/registry/<REGISTRY_NAME>`). The
[Enterprise Cloud UI](../../enterprise-cloud-ui/configure.mdx) needs the
Registry Server's API root instead, set with `server_api_url`:

```yaml title="values.yaml"
enterpriseConfig:
registry:
value:
# For ToolHive clients: the registry API URL (one registry)
api_url: 'https://registry.example.com/registry/toolhive'
# For the Cloud UI: the Registry Server's API root
server_api_url: 'https://registry.example.com'
enforcement: 'enforced'
```

When `server_api_url` isn't set, the Cloud UI falls back to its `API_BASE_URL`
environment variable (see
[Registry API URL resolution](../../enterprise-cloud-ui/configure.mdx#registry-api-url-resolution)).

## Next steps

- [Non-registry servers policy](./non-registry-servers.mdx) to control whether
Expand Down