Skip to content
Ona Docs

DeleteCustomDomain

client.Organizations.CustomDomains.Delete(ctx, body) (*OrganizationCustomDomainDeleteResponse, error)
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 OrganizationCustomDomainDeleteParams
OrganizationID param.Field[string]

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

formatuuid
ReturnsExpand Collapse
type OrganizationCustomDomainDeleteResponse interface{…}

DeleteCustomDomainResponse is the response message for deleting a custom domain

DeleteCustomDomain

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  customDomain, err := client.Organizations.CustomDomains.Delete(context.TODO(), gitpod.OrganizationCustomDomainDeleteParams{
    OrganizationID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customDomain)
}
{}
Returns Examples
{}