workspaces

GET /workspaces/{workspace}/domains/

Changed on

List active custom and Cloudsmith-owned domains available to a workspace. Cloudsmith-owned domains are the shared hostnames every workspace can use; custom domains are listed when enabled and validated, regardless of subscription status. Workspace membership is required, including for service accounts. Discovering a domain does not grant repository access.

For client setup, pass both repository and domain_type, then take the first result as the preferred domain for that repository and purpose. Without repository, the response is a workspace-wide inventory: a REPOSITORY domain must only be used for the repository named in that entry. The endpoint returns results in preference order: REPOSITORY domains come first, then WORKSPACE domains, then GLOBAL domains. Within each custom domain scope, primary domains come before the rest, then the oldest domain comes first.

Responses contain a results array. Follow the Link header's next relation until absent to discover all domains; an empty array means no domains match the filters. A hostname can appear under multiple domain types. Native types are only listed for package formats enabled for the request. Clients should tolerate new domain types.

This endpoint discovers hostnames, not complete package-manager URLs. URL paths and authentication depend on the format and domain scope; custom domains are not necessarily a hostname-only replacement in an existing URL.

Request

  • Base URL
    https://api.cloudsmith.io/v2
  • Auth
    • API key in header X-Api-Key
    • or HTTP basic

Path parameters

workspacestring required

The name of the Workspace.

Query parameters

domain_namestring

Filter to the domain with this name. The match ignores case.

domain_scope'GLOBAL' | 'WORKSPACE' | 'REPOSITORY'

Filter by the scope of the domain.

  • GLOBAL - Global
  • WORKSPACE - Workspace
  • REPOSITORY - Repository
domain_type'DOWNLOAD' | 'UPLOAD' | 'CLOUDSMITH_API' | 'NATIVE_SKILLS' | 'NATIVE_CARGO' | 'NATIVE_COMPOSER' | 'NATIVE_CONAN' | 'NATIVE_CONDA' | 'NATIVE_DART' | 'NATIVE_DOCKER' | 'NATIVE_GENERIC' | 'NATIVE_GO' | 'NATIVE_HELM_OCI' | 'NATIVE_HEX' | 'NATIVE_HUGGINGFACE' | 'NATIVE_MAVEN' | 'NATIVE_NIX' | 'NATIVE_NPM' | 'NATIVE_NUGET' | 'NATIVE_PYTHON' | 'NATIVE_RUBY' | 'NATIVE_SWIFT' | 'NATIVE_TERRAFORM' | 'NATIVE_VSX'

Filter by the purpose the domain serves.

  • DOWNLOAD - Downloads
  • UPLOAD - Uploads
  • CLOUDSMITH_API - Cloudsmith API
  • NATIVE_SKILLS - Native API: AI Skills
  • NATIVE_CARGO - Native API: Cargo
  • NATIVE_COMPOSER - Native API: Composer
  • NATIVE_CONAN - Native API: Conan
  • NATIVE_CONDA - Native API: Conda
  • NATIVE_DART - Native API: Dart
  • NATIVE_DOCKER - Native API: Docker
  • NATIVE_GENERIC - Native API: Generic
  • NATIVE_GO - Native API: Go
  • NATIVE_HELM_OCI - Native API: Helm (OCI)
  • NATIVE_HEX - Native API: Hex
  • NATIVE_HUGGINGFACE - Native API: HuggingFace
  • NATIVE_MAVEN - Native API: Maven
  • NATIVE_NIX - Native API: Nix
  • NATIVE_NPM - Native API: npm
  • NATIVE_NUGET - Native API: NuGet
  • NATIVE_PYTHON - Native API: Python
  • NATIVE_RUBY - Native API: Ruby
  • NATIVE_SWIFT - Native API: Swift
  • NATIVE_TERRAFORM - Native API: Terraform
  • NATIVE_VSX - Native API: VSX
fieldsstring

Comma-separated fields to include in the response (e.g. domain_name,domain_type).

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

repositorystring

Filter to domains that serve this repository, plus the domains that serve the whole workspace. Omit to list domains for all repositories.

Response

Domains in preference order, with pagination in the headers.

Changes

    • warning

      added the new NATIVE_SKILLS enum value to the ////// response property for the response status

    • info

      added the new enum value NATIVE_SKILLS to the query request parameter domain_type

    • info

      endpoint added