---
title: "Add custom domain to the helm."
method: POST
path: "/helm/{helmId}/customDomain"
tags: ["Helm Custom Domain"]
---

# Add custom domain to the helm.

`POST /helm/{helmId}/customDomain`

## Request

- Base URL: `https://api.qovery.com`
- URL: `https://api.qovery.com/helm/{helmId}/customDomain`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/qovery/apis/qovery-api/docs/helm/:helmId/customDomain/post.ts> (a function with typed inputs; its response is checked against the schema)

Add a custom domain to this helm in order not to use qovery autogenerated domain

## Path parameters

- `helmId` string, uuid, required

## Request body

- CustomDomainRequest
  - `domain` string, required: your custom domain
  - `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 `201`

Added helm custom domain

- CustomDomain
  - `id` string, uuid, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time
  - `domain` string, required: your custom domain
  - `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
  - `validation_domain` string: URL provided by Qovery. You must create a CNAME on your DNS provider using that URL
  - `status` 'VALIDATION_PENDING'

## Other responses

- `400`: Bad request
- `401`: Access token is missing or invalid
- `403`: Access forbidden
- `404`: Resource not found

---

[API](https://skmtc.dev/qovery/apis/qovery-api.md) - [All operations](https://skmtc.dev/qovery/apis/qovery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/qovery/apis/qovery-api/revisions/93c4960a44ba?raw)