CreateCustomDomain

POST/gitpod.v1.OrganizationService/CreateCustomDomain

Creates a custom domain configuration for an organization.

Use this method to configure custom domains for organization workspaces

Examples

Configure AWS custom domain:

Sets up a custom domain with AWS provider.

organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
domainName: "workspaces.acme-corp.com"
provider: CUSTOM_DOMAIN_PROVIDER_AWS
awsAccountId: "123456789012"

Body ParametersJSONExpand Collapse

domainName: string

domain_name is the custom domain name

maxLength253

minLength4

organizationId: string

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

formatuuid

DeprecatedawsAccountId: optional string

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

cloudAccountId: optional string

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"

ReturnsExpand Collapse

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

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

cloudAccountId: optional string

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"

CreateCustomDomain

curl https://app.gitpod.io/api/gitpod.v1.OrganizationService/CreateCustomDomain \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{
          "domainName": "workspaces.acme-corp.com",
          "organizationId": "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
        }'

{
  "customDomain": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "domainName": "xxxx",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "awsAccountId": "awsAccountId",
    "cloudAccountId": "cloudAccountId",
    "provider": "CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
  }
}

Returns Examples

{
  "customDomain": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "domainName": "xxxx",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "awsAccountId": "awsAccountId",
    "cloudAccountId": "cloudAccountId",
    "provider": "CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED"
  }
}