Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

Custom Domains

CreateCustomDomain
organizations.custom_domains.create(CustomDomainCreateParams**kwargs) -> CustomDomainCreateResponse
POST/gitpod.v1.OrganizationService/CreateCustomDomain
DeleteCustomDomain
organizations.custom_domains.delete(CustomDomainDeleteParams**kwargs) -> object
POST/gitpod.v1.OrganizationService/DeleteCustomDomain
GetCustomDomain
organizations.custom_domains.retrieve(CustomDomainRetrieveParams**kwargs) -> CustomDomainRetrieveResponse
POST/gitpod.v1.OrganizationService/GetCustomDomain
UpdateCustomDomain
organizations.custom_domains.update(CustomDomainUpdateParams**kwargs) -> CustomDomainUpdateResponse
POST/gitpod.v1.OrganizationService/UpdateCustomDomain
ModelsExpand Collapse
class CustomDomain: …

CustomDomain represents a custom domain configuration for an organization

id: str

id is the unique identifier of the custom domain

formatuuid
created_at: datetime

created_at is when the custom domain was created

formatdate-time
domain_name: str

domain_name is the custom domain name

maxLength253
minLength4
organization_id: str

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

formatuuid
updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time
Deprecatedaws_account_id: Optional[str]

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

cloud_account_id: Optional[str]

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

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:
"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
"CUSTOM_DOMAIN_PROVIDER_AWS"
"CUSTOM_DOMAIN_PROVIDER_GCP"
Literal["CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED", "CUSTOM_DOMAIN_PROVIDER_AWS", "CUSTOM_DOMAIN_PROVIDER_GCP"]

CustomDomainProvider represents the cloud provider for custom domain configuration

One of the following:
"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
"CUSTOM_DOMAIN_PROVIDER_AWS"
"CUSTOM_DOMAIN_PROVIDER_GCP"
class CustomDomainCreateResponse: …

CreateCustomDomainResponse is the response message for creating a custom domain

custom_domain: CustomDomain

custom_domain is the created custom domain

id: str

id is the unique identifier of the custom domain

formatuuid
created_at: datetime

created_at is when the custom domain was created

formatdate-time
domain_name: str

domain_name is the custom domain name

maxLength253
minLength4
organization_id: str

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

formatuuid
updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time
Deprecatedaws_account_id: Optional[str]

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

cloud_account_id: Optional[str]

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

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:
"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
"CUSTOM_DOMAIN_PROVIDER_AWS"
"CUSTOM_DOMAIN_PROVIDER_GCP"
class CustomDomainRetrieveResponse: …
custom_domain: CustomDomain

CustomDomain represents a custom domain configuration for an organization

id: str

id is the unique identifier of the custom domain

formatuuid
created_at: datetime

created_at is when the custom domain was created

formatdate-time
domain_name: str

domain_name is the custom domain name

maxLength253
minLength4
organization_id: str

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

formatuuid
updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time
Deprecatedaws_account_id: Optional[str]

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

cloud_account_id: Optional[str]

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

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:
"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
"CUSTOM_DOMAIN_PROVIDER_AWS"
"CUSTOM_DOMAIN_PROVIDER_GCP"
class CustomDomainUpdateResponse: …

UpdateCustomDomainResponse is the response message for updating a custom domain

custom_domain: CustomDomain

custom_domain is the updated custom domain

id: str

id is the unique identifier of the custom domain

formatuuid
created_at: datetime

created_at is when the custom domain was created

formatdate-time
domain_name: str

domain_name is the custom domain name

maxLength253
minLength4
organization_id: str

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

formatuuid
updated_at: datetime

updated_at is when the custom domain was last updated

formatdate-time
Deprecatedaws_account_id: Optional[str]

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

cloud_account_id: Optional[str]

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

provider: Optional[CustomDomainProvider]

provider is the cloud provider for this custom domain

One of the following:
"CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
"CUSTOM_DOMAIN_PROVIDER_AWS"
"CUSTOM_DOMAIN_PROVIDER_GCP"