Skip to content

Hosting

Workspace hosting regions and regional entry points.

Workspace hosting regions and regional entry points.

See the OpenAPI document for schemas and operation IDs.

  • Protected operations require an API key in x-api-key or a browser session cookie; some actions require a verified user session
  • Tenant-scoped operations use X-Organization-Id; browser sessions can use their active workspace. Discovery and personal-workspace bootstrap do not require an active workspace
  • The base URL for your deployment, https://server.hlix.ai by default
Method Path Operation
GET /v1/api/hosting-regions List configured regional entry points
GET /v1/api/settings/hosting Read the workspace’s immutable hosting region

GET /v1/api/hosting-regions · operation ID listHostingRegions

Authentication — Public; no API key or session required.

Responses

Status Body Description
200 HostingCatalog Deployment catalog; contains no workspace data
400 ApiError The request named no active organization.
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.

Read the workspace’s immutable hosting region

Section titled “Read the workspace’s immutable hosting region”

GET /v1/api/settings/hosting · operation ID getWorkspaceHosting

Parameters

Name In Required Type Description
X-Organization-Id header no string The workspace (organization) to act in. Omitted, the session’s active organization is used.

Responses

Status Body Description
200 WorkspaceHosting Workspace hosting and regional entry points
400 ApiError The request named no active organization.
401 ApiError No valid session or API key.
403 ApiError Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
404 ApiError Workspace not found
409 ApiError Workspace belongs to another regional server

The response table for each operation lists its documented errors. Common status codes include:

  • 400 — the body failed schema validation, or the request named no active organization. A ValidationError body carries the failing fields; an ApiError body carries only error.
  • 401 — no valid session or API key.
  • 403 — authenticated, but not a member of the named organization, or a client collaborator without the required access.
  • 404 — check the resource ID and your access to the selected Workspace.
  • 409 — the expected revision or state is stale, or another operation currently owns the transition.
  • 500 — the operation failed server-side. Retry only where an idempotency key makes that safe.