Skip to content
Ona Docs

Custom Domains

CreateCustomDomain
client.Organizations.CustomDomains.New(ctx, body) (*OrganizationCustomDomainNewResponse, error)
POST/gitpod.v1.OrganizationService/CreateCustomDomain
DeleteCustomDomain
client.Organizations.CustomDomains.Delete(ctx, body) (*OrganizationCustomDomainDeleteResponse, error)
POST/gitpod.v1.OrganizationService/DeleteCustomDomain
GetCustomDomain
client.Organizations.CustomDomains.Get(ctx, body) (*OrganizationCustomDomainGetResponse, error)
POST/gitpod.v1.OrganizationService/GetCustomDomain
UpdateCustomDomain
client.Organizations.CustomDomains.Update(ctx, body) (*OrganizationCustomDomainUpdateResponse, error)
POST/gitpod.v1.OrganizationService/UpdateCustomDomain
ModelsExpand Collapse
type CustomDomain struct{…}

CustomDomain represents a custom domain configuration for an organization

ID string

id is the unique identifier of the custom domain

formatuuid
CreatedAt Time

created_at is when the custom domain was created

formatdate-time
DomainName string

domain_name is the custom domain name

maxLength253
minLength4
OrganizationID string

organization_id is the ID of the organization this custom domain belongs to

formatuuid
UpdatedAt Time

updated_at is when the custom domain was last updated

formatdate-time
DeprecatedAwsAccountID stringOptional

aws_account_id is the AWS account ID (deprecated: use cloud_account_id)

CloudAccountID stringOptional

cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID)

Provider CustomDomainProviderOptional

provider is the cloud provider for this custom domain

One of the following:
const CustomDomainProviderUnspecified CustomDomainProvider = "CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
const CustomDomainProviderAws CustomDomainProvider = "CUSTOM_DOMAIN_PROVIDER_AWS"
const CustomDomainProviderGcp CustomDomainProvider = "CUSTOM_DOMAIN_PROVIDER_GCP"
type CustomDomainProvider string

CustomDomainProvider represents the cloud provider for custom domain configuration

One of the following:
const CustomDomainProviderUnspecified CustomDomainProvider = "CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
const CustomDomainProviderAws CustomDomainProvider = "CUSTOM_DOMAIN_PROVIDER_AWS"
const CustomDomainProviderGcp CustomDomainProvider = "CUSTOM_DOMAIN_PROVIDER_GCP"