API Reference

Custom Domains List

Get the details for all custom domains.

Request

gethttps://api.cloudsmith.io/v2/orgs/{org}/custom-domains
Query params
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.

Response

Responses

Custom domains for the organization.

array of objects

object

backend_kind
integer | null
optional
Allowed values: 0, 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, 99
created_at
date-time
optional
created_by
integer | null
optional
dns_alias_value
string | null
optional
dns_cert_name
string | null
optional
dns_cert_value
string | null
optional
domain_type
integer
optional
Allowed values: 0, 1, 2, 3
enabled
boolean
optional
host
string
optional
length ≥ 1
namespace
integer
optional
primary
boolean
optional
redirect_root
boolean
optional
redirect_root_url
uri | null
optional
repository
object
required
repository_only
boolean
optional
slug_perm
slug
optional
^[-a-zA-Z0-9_]+$
length ≥ 1
validated
boolean
optional
validated_at
date-time
optional

Request could not be processed (see detail).

object

object

detail
string
required
length ≥ 1

Custom Domains are not available; upgrade your account!

object

object

detail
string
required
length ≥ 1

Organization not found.

object

object

detail
string
required
length ≥ 1

Missing or invalid parameters (see detail).

object

object

detail
string
required
length ≥ 1