API Reference

Organizations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Custom Domains

CreateCustomDomain

client.organizations.customDomains.create(CustomDomainCreateParams { domainName, organizationId, awsAccountId, 2 more } body, RequestOptionsoptions?): CustomDomainCreateResponse { customDomain }

POST/gitpod.v1.OrganizationService/CreateCustomDomain

DeleteCustomDomain

client.organizations.customDomains.delete(CustomDomainDeleteParams { organizationId } body, RequestOptionsoptions?): CustomDomainDeleteResponse

POST/gitpod.v1.OrganizationService/DeleteCustomDomain

GetCustomDomain

client.organizations.customDomains.retrieve(CustomDomainRetrieveParams { organizationId } body, RequestOptionsoptions?): CustomDomainRetrieveResponse { customDomain }

POST/gitpod.v1.OrganizationService/GetCustomDomain

UpdateCustomDomain

client.organizations.customDomains.update(CustomDomainUpdateParams { domainName, organizationId, awsAccountId, 2 more } body, RequestOptionsoptions?): CustomDomainUpdateResponse { customDomain }

POST/gitpod.v1.OrganizationService/UpdateCustomDomain

ModelsExpand Collapse

CustomDomain { id, createdAt, domainName, 5 more }

CustomDomain represents a custom domain configuration for an organization

id: string

id is the unique identifier of the custom domain

formatuuid

createdAt: string

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: string

updated_at is when the custom domain was last updated

formatdate-time

DeprecatedawsAccountId?: string

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

cloudAccountId?: string

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

provider?: 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"

CustomDomainProvider = "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"

CustomDomainCreateResponse { customDomain }

CreateCustomDomainResponse is the response message for creating a custom domain

customDomain: CustomDomain { id, createdAt, domainName, 5 more }

custom_domain is the created custom domain

id: string

id is the unique identifier of the custom domain

formatuuid

createdAt: string

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: string

updated_at is when the custom domain was last updated

formatdate-time

DeprecatedawsAccountId?: string

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

cloudAccountId?: string

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

provider?: 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"

CustomDomainDeleteResponse = unknown

DeleteCustomDomainResponse is the response message for deleting a custom domain

CustomDomainRetrieveResponse { customDomain }

customDomain: CustomDomain { id, createdAt, domainName, 5 more }

CustomDomain represents a custom domain configuration for an organization

id: string

id is the unique identifier of the custom domain

formatuuid

createdAt: string

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: string

updated_at is when the custom domain was last updated

formatdate-time

DeprecatedawsAccountId?: string

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

cloudAccountId?: string

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

provider?: 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"

CustomDomainUpdateResponse { customDomain }

UpdateCustomDomainResponse is the response message for updating a custom domain

customDomain: CustomDomain { id, createdAt, domainName, 5 more }

custom_domain is the updated custom domain

id: string

id is the unique identifier of the custom domain

formatuuid

createdAt: string

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: string

updated_at is when the custom domain was last updated

formatdate-time

DeprecatedawsAccountId?: string

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

cloudAccountId?: string

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

provider?: 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"