Skip to main content
PUT
/
helm
/
{helmId}
/
customDomain
/
{customDomainId}
Edit a Custom Domain
curl --request PUT \
  --url https://api.qovery.com/helm/{helmId}/customDomain/{customDomainId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "domain": "my.domain.tld",
  "generate_certificate": true,
  "use_cdn": true
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "domain": "my.domain.tld",
  "generate_certificate": true,
  "use_cdn": true,
  "validation_domain": "<string>",
  "status": "VALIDATION_PENDING"
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

​
helmId
string<uuid>
required

Helm ID

​
customDomainId
string<uuid>
required

Custom Domain ID

Body

application/json
​
domain
string
required

your custom domain

Example:

"my.domain.tld"

​
generate_certificate
boolean
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_cdn
boolean

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

Response

Edit a CustomDomain

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
domain
string
required

your custom domain

Example:

"my.domain.tld"

​
generate_certificate
boolean
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.

​
updated_at
string<date-time>
​
use_cdn
boolean

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_domain
string

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

​
status
enum<string>
Available options:
VALIDATION_PENDING
Example:

"VALIDATION_PENDING"