> ## Documentation Index
> Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit cluster DNS provider

> Update the DNS provider associated with a cluster. Requires an Enterprise plan.
Cloudflare api_token and Route53 STATIC credentials aws_secret_access_key must be provided on every edit.




## OpenAPI

````yaml /api-reference/openapi.yaml put /cluster/{clusterId}/dnsProvider
openapi: 3.0.0
info:
  version: 1.0.4
  title: Qovery API
  description: >
    - Qovery is the fastest way to deploy your full-stack apps on any Cloud
    provider.

    - ℹ️ The API is stable and still in development.
  contact:
    name: Qovery Product Team
    url: https://www.qovery.com
    email: support+api+documentation@qovery.com
  x-logo:
    url: https://console.qovery.com/assets/logos/logo-white.svg
    altText: Qovery
servers:
  - url: https://api.qovery.com
security:
  - bearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Account
  - name: Account Info
  - name: Alert Receivers
  - name: Alert Rules
  - name: Admin
  - name: ArgoCD
  - name: Application
  - name: Application Actions
  - name: Application Configuration
  - name: Application Database
  - name: Application Deployment Restriction
  - name: Application Deployment History
  - name: Application Environment Variable
  - name: Application Logs
  - name: Application Main Calls
  - name: Application Secret
  - name: Application Annotations Group
  - name: Applications
  - name: AutoscalingPolicy
  - name: Container
  - name: Container Actions
  - name: Container Configuration
  - name: Container Database
  - name: Container Deployment History
  - name: Container Environment Variable
  - name: Container Logs
  - name: Container Main Calls
  - name: Container Registry
  - name: Container Secret
  - name: Container Annotations Group
  - name: Containers
  - name: Deployment Stage Main Calls
  - name: Job
  - name: Job Actions
  - name: Job Configuration
  - name: Job Database
  - name: Job Deployment Restriction
  - name: Job Deployment History
  - name: Job Environment Variable
  - name: Job Logs
  - name: Job Main Calls
  - name: Job Registry
  - name: Job Secret
  - name: Job Annotations Group
  - name: Jobs
  - name: KedaTriggerAuthentication
  - name: Helm
  - name: Helm Actions
  - name: Helm Configuration
  - name: Helm Database
  - name: Helm Deployment Restriction
  - name: Helm Deployment History
  - name: Helm Logs
  - name: Helm Main Calls
  - name: Helm Repository
  - name: Helms
  - name: Backups
  - name: Billing
  - name: Cloud Provider
  - name: Cloud Provider Credentials
  - name: Clusters
  - name: Custom Domain
  - name: Container Custom Domain
  - name: Database
  - name: Database Actions
  - name: Database Application
  - name: Database Container
  - name: Database Deployment History
  - name: Database Main Calls
  - name: Database Annotations Group
  - name: Databases
  - name: Environment
  - name: Environment Actions
  - name: Environment Deployment History
  - name: Environment Deployment Rule
  - name: Environment Logs
  - name: Environment Main Calls
  - name: Environment Secret
  - name: Environment Variable
  - name: Environments
  - name: Git
  - name: Github App
  - name: Git repositories
  - name: Members
  - name: Organization
  - name: Organization Account Git Repositories
  - name: Organization Cluster Lock
  - name: Organization Main Calls
  - name: Organization Custom Role
  - name: Organization Event
  - name: Organization Api Token
  - name: Organization Webhook
  - name: Organization Annotations Group
  - name: Organization Labels Group
  - name: Organization Enterprise Connection
  - name: Project
  - name: Project Deployment Rule
  - name: Project Environment Variable
  - name: Project Main Calls
  - name: Project Secret
  - name: Projects
  - name: Referral & Rewards
  - name: Secret Manager Access
  - name: Terraforms
  - name: Terraform Main Calls
  - name: Terraform Resources
  - name: Terraform Deployment History
  - name: Terraform Deployment Restriction
  - name: Container Registries
  - name: Helm Repositories
  - name: User Sign Up
  - name: Variable Main Calls
  - name: Helm Custom Domain
  - name: Lifecycle Template Main Calls
paths:
  /cluster/{clusterId}/dnsProvider:
    put:
      tags:
        - Clusters
      summary: Edit cluster DNS provider
      description: >
        Update the DNS provider associated with a cluster. Requires an
        Enterprise plan.

        Cloudflare api_token and Route53 STATIC credentials
        aws_secret_access_key must be provided on every edit.
      operationId: editClusterDnsProvider
      parameters:
        - $ref: '#/components/parameters/clusterId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterDnsProviderRequest'
      responses:
        '200':
          description: Updated cluster DNS provider
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterDnsProviderResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
components:
  parameters:
    clusterId:
      name: clusterId
      in: path
      description: Cluster ID
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    ClusterDnsProviderRequest:
      type: object
      required:
        - dns_provider
      properties:
        dns_provider:
          $ref: '#/components/schemas/ClusterDnsProviderRequestProvider'
    ClusterDnsProviderResponse:
      type: object
      required:
        - dns_provider
      properties:
        dns_provider:
          $ref: '#/components/schemas/ClusterDnsProviderResponseProvider'
    ClusterDnsProviderRequestProvider:
      oneOf:
        - $ref: '#/components/schemas/QoveryDnsProviderRequest'
        - $ref: '#/components/schemas/CloudflareDnsProviderRequest'
        - $ref: '#/components/schemas/Route53DnsProviderRequest'
      discriminator:
        propertyName: provider
        mapping:
          QOVERY:
            $ref: '#/components/schemas/QoveryDnsProviderRequest'
          CLOUDFLARE:
            $ref: '#/components/schemas/CloudflareDnsProviderRequest'
          ROUTE53:
            $ref: '#/components/schemas/Route53DnsProviderRequest'
    ClusterDnsProviderResponseProvider:
      oneOf:
        - $ref: '#/components/schemas/QoveryDnsProviderResponse'
        - $ref: '#/components/schemas/CloudflareDnsProviderResponse'
        - $ref: '#/components/schemas/Route53DnsProviderResponse'
      discriminator:
        propertyName: provider
        mapping:
          QOVERY:
            $ref: '#/components/schemas/QoveryDnsProviderResponse'
          CLOUDFLARE:
            $ref: '#/components/schemas/CloudflareDnsProviderResponse'
          ROUTE53:
            $ref: '#/components/schemas/Route53DnsProviderResponse'
    QoveryDnsProviderRequest:
      type: object
      required:
        - provider
        - domain
      properties:
        provider:
          type: string
          enum:
            - QOVERY
        domain:
          type: string
          example: example.com
    CloudflareDnsProviderRequest:
      type: object
      required:
        - provider
        - domain
        - email
        - api_token
      properties:
        provider:
          type: string
          enum:
            - CLOUDFLARE
        domain:
          type: string
          example: example.com
        email:
          type: string
          format: email
          example: admin@example.com
        api_token:
          type: string
          minLength: 1
          writeOnly: true
          description: >-
            Cloudflare API token. Must be provided when editing Cloudflare DNS
            provider.
        proxied:
          type: boolean
          default: false
    Route53DnsProviderRequest:
      type: object
      required:
        - provider
        - domain
        - credentials
        - aws_region
      properties:
        provider:
          type: string
          enum:
            - ROUTE53
        domain:
          type: string
          example: example.com
        credentials:
          $ref: '#/components/schemas/Route53DnsProviderRequestCredentials'
        aws_region:
          type: string
          example: eu-west-3
        hosted_zone_id:
          type: string
          nullable: true
          example: Z0965488LE74BWDEVQDB
    QoveryDnsProviderResponse:
      type: object
      required:
        - provider
        - domain
      properties:
        provider:
          type: string
          enum:
            - QOVERY
        domain:
          type: string
          example: example.com
    CloudflareDnsProviderResponse:
      type: object
      required:
        - provider
        - domain
        - email
        - proxied
      properties:
        provider:
          type: string
          enum:
            - CLOUDFLARE
        domain:
          type: string
          example: example.com
        email:
          type: string
          format: email
          example: admin@example.com
        proxied:
          type: boolean
    Route53DnsProviderResponse:
      type: object
      required:
        - provider
        - domain
        - credentials
        - aws_region
      properties:
        provider:
          type: string
          enum:
            - ROUTE53
        domain:
          type: string
          example: example.com
        credentials:
          $ref: '#/components/schemas/Route53DnsProviderResponseCredentials'
        aws_region:
          type: string
          example: eu-west-3
        hosted_zone_id:
          type: string
          nullable: true
          example: Z0965488LE74BWDEVQDB
    Route53DnsProviderRequestCredentials:
      oneOf:
        - $ref: '#/components/schemas/Route53StaticCredentialsRequest'
      discriminator:
        propertyName: type
        mapping:
          STATIC:
            $ref: '#/components/schemas/Route53StaticCredentialsRequest'
    Route53DnsProviderResponseCredentials:
      oneOf:
        - $ref: '#/components/schemas/Route53StaticCredentialsResponse'
      discriminator:
        propertyName: type
        mapping:
          STATIC:
            $ref: '#/components/schemas/Route53StaticCredentialsResponse'
    Route53StaticCredentialsRequest:
      type: object
      required:
        - type
        - aws_access_key_id
        - aws_secret_access_key
      properties:
        type:
          type: string
          enum:
            - STATIC
        aws_access_key_id:
          type: string
          minLength: 1
          description: >-
            AWS access key identifier. It is returned by the GET endpoint and
            must be sent back when editing Route53.
        aws_secret_access_key:
          type: string
          minLength: 1
          writeOnly: true
          description: >-
            AWS secret access key. Must be provided when editing Route53 DNS
            provider.
    Route53StaticCredentialsResponse:
      type: object
      required:
        - type
        - aws_access_key_id
      properties:
        type:
          type: string
          enum:
            - STATIC
        aws_access_key_id:
          type: string
          description: AWS access key identifier.
  responses:
    '400':
      description: Bad request
    '401':
      description: Access token is missing or invalid
    '403':
      description: Access forbidden
    '404':
      description: Resource not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT tokens should be used with OIDC account (human to machine). JWT
        tokens used by the Qovery console to communicate with the API have a
        TTL. Curl Example ' curl https://console.qovery.com/organization -H
        "Authorization: Bearer $qovery_token" '
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token API are generated by Qovery to manage machine to machine
        interaction and do not have a TTL. Curl Example ' curl
        https://console.qovery.com/organization -H "Authorization: Token
        $qovery_token" '

````