CLcloudsmith
orgs

Get the details for all custom domains.

Get the details for all custom domains.

get/orgs/{org}/custom-domains/

Request

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

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

Retrieved the list of custom domains for the organization.

backend_kind0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 99 nullable

The domain for a specific package format.

created_atstring date-time
created_byinteger nullable
dns_alias_valuestring nullable

The CNAME value to use to publish this domain publicly.

dns_cert_namestring nullable

The CNAME name to create to allow us to generate a TLS cert.

dns_cert_valuestring nullable

The CNAME value to use to allow us to generate a TLS cert.

domain_type0 | 1 | 2 | 3

The type for the custom domain.

enabledboolean

If checked, the domain is enabled.

hoststring
namespaceinteger
primaryboolean

If checked, this domain is the preferred/primary domain in the case that there are other overlapping domains (e.g. for the same repository, package format, etc.)

redirect_rootboolean

If checked, the domain root redirects to the repository.

redirect_root_urlstring uri nullable

Where root requests should be redirected to if redirect_root is enabled.

repository_onlyboolean

If checked, the domain applies to a specific repository only.

slug_permstring slug
validatedboolean

If validated, the domain is ready for requests.

validated_atstring date-time

Changes

No recorded changes to this operation across all 6 revisions of this API.