DeleteCustomDomain

client.organizations.customDomains.delete(, ?): CustomDomainDeleteResponse

POST/gitpod.v1.OrganizationService/DeleteCustomDomain

Removes a custom domain configuration from an organization.

Use this method to:

Disable custom domain functionality
Remove outdated configurations
Clean up unused domains

Examples

Delete custom domain configuration:

Removes a specific custom domain configuration.
```
organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
```

ParametersExpand Collapse

body: CustomDomainDeleteParams { organizationId }

organizationId: string

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

formatuuid

ReturnsExpand Collapse

CustomDomainDeleteResponse = unknown

DeleteCustomDomainResponse is the response message for deleting a custom domain

DeleteCustomDomain

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const customDomain = await client.organizations.customDomains.delete({
  organizationId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

console.log(customDomain);

{}

Returns Examples

{}