// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="dns-config-openshift-io-v1"]
= DNS [config.openshift.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
DNS holds cluster-wide information about DNS. The canonical name is `cluster`

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--

Type::
  `object`

Required::
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| spec holds user settable values for configuration

| `status`
| `object`
| status holds observed values from the cluster. They may not be overridden.

|===
=== .spec
Description::
+
--
spec holds user settable values for configuration
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `baseDomain`
| `string`
| baseDomain is the base domain of the cluster. All managed DNS records will
be sub-domains of this base.

For example, given the base domain `openshift.example.com`, an API server
DNS record may be created for `cluster-api.openshift.example.com`.

Once set, this field cannot be changed.

| `platform`
| `object`
| platform holds configuration specific to the underlying
infrastructure provider for DNS.
When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.

| `privateZone`
| `object`
| privateZone is the location where all the DNS records that are only available internally
to the cluster exist.

If this field is nil, no private records should be created.

Once set, this field cannot be changed.

| `publicZone`
| `object`
| publicZone is the location where all the DNS records that are publicly accessible to
the internet exist.

If this field is nil, no public records should be created.

Once set, this field cannot be changed.

|===
=== .spec.platform
Description::
+
--
platform holds configuration specific to the underlying
infrastructure provider for DNS.
When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `aws`
| `object`
| aws contains DNS configuration specific to the Amazon Web Services cloud provider.

| `type`
| `string`
| type is the underlying infrastructure provider for the cluster.
Allowed values: "", "AWS".

Individual components may not support all platforms,
and must handle unrecognized platforms with best-effort defaults.

|===
=== .spec.platform.aws
Description::
+
--
aws contains DNS configuration specific to the Amazon Web Services cloud provider.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `privateZoneIAMRole`
| `string`
| privateZoneIAMRole contains the ARN of an IAM role that should be assumed when performing
operations on the cluster's private hosted zone specified in the cluster DNS config.
When left empty, no role should be assumed.

The ARN must follow the format: arn:<partition>:iam::<account-id>:role/<role-name>, where:
<partition> is the AWS partition (aws, aws-cn, aws-us-gov, or aws-eusc),
<account-id> is a 12-digit numeric identifier for the AWS account,
<role-name> is the IAM role name.

|===
=== .spec.privateZone
Description::
+
--
privateZone is the location where all the DNS records that are only available internally
to the cluster exist.

If this field is nil, no private records should be created.

Once set, this field cannot be changed.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `id`
| `string`
| id is the identifier that can be used to find the DNS hosted zone.

on AWS zone can be fetched using `ID` as id in [1]
on Azure zone can be fetched using `ID` as a pre-determined name in [2],
on GCP zone can be fetched using `ID` as a pre-determined name in [3].

[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options
[2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show
[3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get

| `tags`
| `object (string)`
| tags can be used to query the DNS hosted zone.

on AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters,

[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

|===
=== .spec.publicZone
Description::
+
--
publicZone is the location where all the DNS records that are publicly accessible to
the internet exist.

If this field is nil, no public records should be created.

Once set, this field cannot be changed.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `id`
| `string`
| id is the identifier that can be used to find the DNS hosted zone.

on AWS zone can be fetched using `ID` as id in [1]
on Azure zone can be fetched using `ID` as a pre-determined name in [2],
on GCP zone can be fetched using `ID` as a pre-determined name in [3].

[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options
[2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show
[3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get

| `tags`
| `object (string)`
| tags can be used to query the DNS hosted zone.

on AWS, resourcegroupstaggingapi [1] can be used to fetch a zone using `Tags` as tag-filters,

[1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

|===
=== .status
Description::
+
--
status holds observed values from the cluster. They may not be overridden.
--

Type::
  `object`





== API endpoints

The following API endpoints are available:

* `/apis/config.openshift.io/v1/dnses`
- `DELETE`: delete collection of DNS
- `GET`: list objects of kind DNS
- `POST`: create a DNS
* `/apis/config.openshift.io/v1/dnses/{name}`
- `DELETE`: delete a DNS
- `GET`: read the specified DNS
- `PATCH`: partially update the specified DNS
- `PUT`: replace the specified DNS
* `/apis/config.openshift.io/v1/dnses/{name}/status`
- `GET`: read status of the specified DNS
- `PATCH`: partially update status of the specified DNS
- `PUT`: replace status of the specified DNS


=== /apis/config.openshift.io/v1/dnses



HTTP method::
  `DELETE`

Description::
  delete collection of DNS




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind DNS




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-config-v1-DNSList[`DNSList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a DNS


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 201 - Created
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 202 - Accepted
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1/dnses/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the DNS
|===


HTTP method::
  `DELETE`

Description::
  delete a DNS


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified DNS




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified DNS


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified DNS


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 201 - Created
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1/dnses/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the DNS
|===


HTTP method::
  `GET`

Description::
  read status of the specified DNS




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified DNS


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified DNS


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 201 - Created
| xref:../config_apis/dns-config-openshift-io-v1.adoc#dns-config-openshift-io-v1[`DNS`] schema
| 401 - Unauthorized
| Empty
|===


