QOqovery
Helm Custom Domain

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

put/helm/{helmId}/customDomain/{customDomainId}

Request

Path parameters

helmIdstring uuid required

Helm ID

customDomainIdstring uuid required

Custom Domain ID

Request body

domainstring required

your custom domain

generate_certificateboolean required

to control if a certificate has to be generated for this custom domain by Qovery. The default value is true. This flag should be set to false if a CDN or other entities are managing the certificate for the specified domain and the traffic is proxied by the CDN to Qovery.

use_cdnboolean

Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

  • If true then we only check the domain points to an IP
  • If false then we check that the domain resolves to the correct service Load Balancer

Example request

{
  "domain": "my.domain.tld"
}

Response

Edit a CustomDomain

idstring uuid required
created_atstring date-time required
updated_atstring date-time
domainstring required

your custom domain

generate_certificateboolean required

to control if a certificate has to be generated for this custom domain by Qovery. The default value is true. This flag should be set to false if a CDN or other entities are managing the certificate for the specified domain and the traffic is proxied by the CDN to Qovery.

use_cdnboolean

Indicates if the custom domain is behind a CDN (i.e Cloudflare). This will condition the way we are checking CNAME before & during a deployment:

  • If true then we only check the domain points to an IP
  • If false then we check that the domain resolves to the correct service Load Balancer
validation_domainstring

URL provided by Qovery. You must create a CNAME on your DNS provider using that URL

status'VALIDATION_PENDING'

Example response

{
  "domain": "my.domain.tld",
  "status": "VALIDATION_PENDING"
}

Changes

No recorded changes to this operation across all 1 revision of this API.