v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.OrganizationService

UpdateCustomDomain

Updates custom domain configuration settings.

Use this method to:

  • Update cloud provider settings
  • Change AWS account ID
  • Modify domain configuration

Examples

  • Update AWS account ID:

    Changes the AWS account ID for the custom domain.

    organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    domainName: "workspaces.acme-corp.com"
    awsAccountId: "987654321098"
    
post/gitpod.v1.OrganizationService/UpdateCustomDomain

Request body

awsAccountIdstring nullable

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

cloudAccountIdstring nullable

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

domainNamestring required

domain_name is the custom domain name

organizationIdstring uuid required

organization_id is the ID of the organization to update custom domain for

provider'CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED' | 'CUSTOM_DOMAIN_PROVIDER_AWS' | 'CUSTOM_DOMAIN_PROVIDER_GCP'

CustomDomainProvider represents the cloud provider for custom domain configuration

Response

Success