---
title: "Update a DNS Forwarder"
method: PATCH
path: "/networking/v1/dns-forwarders/{id}"
tags: ["DNS Forwarders (networking/v1)"]
---

# Update a DNS Forwarder

`PATCH /networking/v1/dns-forwarders/{id}`

[![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Make a request to update a DNS forwarder.

## Path parameters

- `id` string, required

## Request body

- object — Add, remove, and update DNS forwarder for your gateway. Related guides: * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). ## The DNS Forwarders Model <SchemaDefinition schemaRef="#/components/schemas/networking.v1.DnsForwarder" />
  - `api_version` 'networking/v1' — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'DnsForwarder' — Kind defines the object this REST resource represents.
  - `id` string — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
  - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
    - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
    - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
    - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
    - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
  - `spec` object, required — The desired state of the Dns Forwarder
    - `display_name` string — The name of the DNS forwarder
    - `domains` string[] — List of domains for the DNS forwarder to use
    - `config` object — DNS Forwarder Configured via DNS Server IPs.
      - `kind` 'ForwardViaIp', required — DNS Forwarder Configured via DNS Server IPs kind type.
      - `dns_server_ips` NetworkingV1Ip[], required — List of IP addresses of the DNS server
    - `environment` object, required — The environment to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
    - `gateway` ObjectReference — ObjectReference provides information for you to locate the referred object
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
  - `status` NetworkingV1DnsForwarderStatus — The status of the Dns Forwarder
    - `phase` string, required — The lifecycle phase of the DNS forwarder: PROVISIONING: DNS forwarder provisioning is in progress; CREATED: DNS forwarder is created. It will automatically become ready once a Kafka cluster is provisioned; READY: DNS forwarder is ready; FAILED: DNS forwarder is in a failed state; DEGRADED: DNS forwarder is in a degraded state, transitioning from 'READY' due to unreachable DNS resolvers; DEPROVISIONING: DNS forwarder deprovisioning is in progress;
    - `error_code` string — Error code if dns forwarder is in a failed state. May be used for programmatic error checking.
    - `error_message` string — Displayable error message if dns forwarder is in a failed state

## Response `200`

DNS Forwarder.

- object — Add, remove, and update DNS forwarder for your gateway. Related guides: * [Use VPC peering connections with Confluent Cloud on AWS](https://docs.confluent.io/cloud/current/networking/peering/aws-peering.html). * [Use VNet peering connections with Confluent Cloud on Azure](https://docs.confluent.io/cloud/current/networking/peering/azure-peering.html). ## The DNS Forwarders Model <SchemaDefinition schemaRef="#/components/schemas/networking.v1.DnsForwarder" />
  - `api_version` 'networking/v1', required — APIVersion defines the schema version of this representation of a resource.
  - `kind` 'DnsForwarder', required — Kind defines the object this REST resource represents.
  - `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
  - `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
    - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
    - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
    - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
    - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
    - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
  - `spec` object, required — The desired state of the Dns Forwarder
    - `display_name` string — The name of the DNS forwarder
    - `domains` string[], required — List of domains for the DNS forwarder to use
    - `config` object, required — DNS Forwarder Configured via DNS Server IPs.
      - `kind` 'ForwardViaIp', required — DNS Forwarder Configured via DNS Server IPs kind type.
      - `dns_server_ips` NetworkingV1Ip[], required — List of IP addresses of the DNS server
    - `environment` object, required — The environment to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
    - `gateway` object, required — The gateway to which this belongs.
      - `id` string, required — ID of the referred resource
      - `environment` string — Environment of the referred resource, if env-scoped
      - `related` string, uri, required — API URL for accessing or modifying the referred object
      - `resource_name` string, uri, required — CRN reference to the referred resource
      - `api_version` string — API group and version of the referred resource
      - `kind` string — Kind of the referred resource
  - `status` NetworkingV1DnsForwarderStatus, required — The status of the Dns Forwarder
    - `phase` string, required — The lifecycle phase of the DNS forwarder: PROVISIONING: DNS forwarder provisioning is in progress; CREATED: DNS forwarder is created. It will automatically become ready once a Kafka cluster is provisioned; READY: DNS forwarder is ready; FAILED: DNS forwarder is in a failed state; DEGRADED: DNS forwarder is in a degraded state, transitioning from 'READY' due to unreachable DNS resolvers; DEPROVISIONING: DNS forwarder deprovisioning is in progress;
    - `error_code` string — Error code if dns forwarder is in a failed state. May be used for programmatic error checking.
    - `error_message` string — Displayable error message if dns forwarder is in a failed state

## Other responses

- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `409` — The request is in conflict with the current server state
- `422` — Validation Failed
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!

---

[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)