openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity
Files
enterprise-4.21
openshift-docs/rest_api/config_apis/apiserver-config-openshift-io-v1.adoc
JoeAldinger e59b22b534 OSDOCS-15079: update rest_api docs for 4.21
2026-01-27 22:07:18 +00:00

994 lines
29 KiB
Plaintext
Raw Permalink Blame History

// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="apiserver-config-openshift-io-v1"]
= APIServer [config.openshift.io/v1]
:toc: macro
:toc-title:
toc::[]
Description::
+
--
APIServer holds configuration (like serving certificates, client CA and CORS domains)
shared by all API servers in the system, among them especially kube-apiserver
and openshift-apiserver. The canonical name of an instance 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
| `additionalCORSAllowedOrigins`
| `array (string)`
| additionalCORSAllowedOrigins lists additional, user-defined regular expressions describing hosts for which the
API server allows access using the CORS headers. This may be needed to access the API and the integrated OAuth
server from JavaScript applications.
The values are regular expressions that correspond to the Golang regular expression language.
| `audit`
| `object`
| audit specifies the settings for audit configuration to be applied to all OpenShift-provided
API servers in the cluster.
| `clientCA`
| `object`
| clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for
incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid.
You usually only have to set this if you have your own PKI you wish to honor client certificates from.
The ConfigMap must exist in the openshift-config namespace and contain the following required fields:
- ConfigMap.Data["ca-bundle.crt"] - CA bundle.
| `encryption`
| `object`
| encryption allows the configuration of encryption of resources at the datastore layer.
| `servingCerts`
| `object`
| servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates
will be used for serving secure traffic.
| `tlsSecurityProfile`
| `object`
| tlsSecurityProfile specifies settings for TLS connections for externally exposed servers.
When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
The current default is the Intermediate profile.
|===
=== .spec.audit
Description::
+
--
audit specifies the settings for audit configuration to be applied to all OpenShift-provided
API servers in the cluster.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `customRules`
| `array`
| customRules specify profiles per group. These profile take precedence over the
top-level profile field if they apply. They are evaluation from top to bottom and
the first one that matches, applies.
| `customRules[]`
| `object`
| AuditCustomRule describes a custom rule for an audit profile that takes precedence over
the top-level profile.
| `profile`
| `string`
| profile specifies the name of the desired top-level audit profile to be applied to all requests
sent to any of the OpenShift-provided API servers in the cluster (kube-apiserver,
openshift-apiserver and oauth-apiserver), with the exception of those requests that match
one or more of the customRules.
The following profiles are provided:
- Default: default policy which means MetaData level logging with the exception of events
(not logged at all), oauthaccesstokens and oauthauthorizetokens (both logged at RequestBody
level).
- WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for
write requests (create, update, patch).
- AllRequestBodies: like 'WriteRequestBodies', but also logs request and response
HTTP payloads for read requests (get, list).
- None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.
Warning: It is not recommended to disable audit logging by using the `None` profile unless you
are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues.
If you disable audit logging and a support situation arises, you might need to enable audit logging
and reproduce the issue in order to troubleshoot properly.
If unset, the 'Default' profile is used as the default.
|===
=== .spec.audit.customRules
Description::
+
--
customRules specify profiles per group. These profile take precedence over the
top-level profile field if they apply. They are evaluation from top to bottom and
the first one that matches, applies.
--
Type::
`array`
=== .spec.audit.customRules[]
Description::
+
--
AuditCustomRule describes a custom rule for an audit profile that takes precedence over
the top-level profile.
--
Type::
`object`
Required::
- `group`
- `profile`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `group`
| `string`
| group is a name of group a request user must be member of in order to this profile to apply.
| `profile`
| `string`
| profile specifies the name of the desired audit policy configuration to be deployed to
all OpenShift-provided API servers in the cluster.
The following profiles are provided:
- Default: the existing default policy.
- WriteRequestBodies: like 'Default', but logs request and response HTTP payloads for
write requests (create, update, patch).
- AllRequestBodies: like 'WriteRequestBodies', but also logs request and response
HTTP payloads for read requests (get, list).
- None: no requests are logged at all, not even oauthaccesstokens and oauthauthorizetokens.
If unset, the 'Default' profile is used as the default.
|===
=== .spec.clientCA
Description::
+
--
clientCA references a ConfigMap containing a certificate bundle for the signers that will be recognized for
incoming client certificates in addition to the operator managed signers. If this is empty, then only operator managed signers are valid.
You usually only have to set this if you have your own PKI you wish to honor client certificates from.
The ConfigMap must exist in the openshift-config namespace and contain the following required fields:
- ConfigMap.Data["ca-bundle.crt"] - CA bundle.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name is the metadata.name of the referenced config map
|===
=== .spec.encryption
Description::
+
--
encryption allows the configuration of encryption of resources at the datastore layer.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `kms`
| `object`
| kms defines the configuration for the external KMS instance that manages the encryption keys,
when KMS encryption is enabled sensitive resources will be encrypted using keys managed by an
externally configured KMS instance.
The Key Management Service (KMS) instance provides symmetric encryption and is responsible for
managing the lifecyle of the encryption keys outside of the control plane.
This allows integration with an external provider to manage the data encryption keys securely.
| `type`
| `string`
| type defines what encryption type should be used to encrypt resources at the datastore layer.
When this field is unset (i.e. when it is set to the empty string), identity is implied.
The behavior of unset can and will change over time. Even if encryption is enabled by default,
the meaning of unset may change to a different encryption type based on changes in best practices.
When encryption is enabled, all sensitive resources shipped with the platform are encrypted.
This list of sensitive resources can and will change over time. The current authoritative list is:
1. secrets
2. configmaps
3. routes.route.openshift.io
4. oauthaccesstokens.oauth.openshift.io
5. oauthauthorizetokens.oauth.openshift.io
|===
=== .spec.encryption.kms
Description::
+
--
kms defines the configuration for the external KMS instance that manages the encryption keys,
when KMS encryption is enabled sensitive resources will be encrypted using keys managed by an
externally configured KMS instance.
The Key Management Service (KMS) instance provides symmetric encryption and is responsible for
managing the lifecyle of the encryption keys outside of the control plane.
This allows integration with an external provider to manage the data encryption keys securely.
--
Type::
`object`
Required::
- `type`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `aws`
| `object`
| aws defines the key config for using an AWS KMS instance
for the encryption. The AWS KMS instance is managed
by the user outside the purview of the control plane.
| `type`
| `string`
| type defines the kind of platform for the KMS provider.
Available provider types are AWS only.
|===
=== .spec.encryption.kms.aws
Description::
+
--
aws defines the key config for using an AWS KMS instance
for the encryption. The AWS KMS instance is managed
by the user outside the purview of the control plane.
--
Type::
`object`
Required::
- `keyARN`
- `region`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `keyARN`
| `string`
| keyARN specifies the Amazon Resource Name (ARN) of the AWS KMS key used for encryption.
The value must adhere to the format `arn:aws:kms:<region>:<account_id>:key/<key_id>`, where:
- `<region>` is the AWS region consisting of lowercase letters and hyphens followed by a number.
- `<account_id>` is a 12-digit numeric identifier for the AWS account.
- `<key_id>` is a unique identifier for the KMS key, consisting of lowercase hexadecimal characters and hyphens.
| `region`
| `string`
| region specifies the AWS region where the KMS instance exists, and follows the format
`<region-prefix>-<region-name>-<number>`, e.g.: `us-east-1`.
Only lowercase letters and hyphens followed by numbers are allowed.
|===
=== .spec.servingCerts
Description::
+
--
servingCert is the TLS cert info for serving secure traffic. If not specified, operator managed certificates
will be used for serving secure traffic.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `namedCertificates`
| `array`
| namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames.
If no named certificates are provided, or no named certificates match the server name as understood by a client,
the defaultServingCertificate will be used.
| `namedCertificates[]`
| `object`
| APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.
|===
=== .spec.servingCerts.namedCertificates
Description::
+
--
namedCertificates references secrets containing the TLS cert info for serving secure traffic to specific hostnames.
If no named certificates are provided, or no named certificates match the server name as understood by a client,
the defaultServingCertificate will be used.
--
Type::
`array`
=== .spec.servingCerts.namedCertificates[]
Description::
+
--
APIServerNamedServingCert maps a server DNS name, as understood by a client, to a certificate.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `names`
| `array (string)`
| names is a optional list of explicit DNS names (leading wildcards allowed) that should use this certificate to
serve secure traffic. If no names are provided, the implicit names will be extracted from the certificates.
Exact names trump over wildcard names. Explicit names defined here trump over extracted implicit names.
| `servingCertificate`
| `object`
| servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic.
The secret must exist in the openshift-config namespace and contain the following required fields:
- Secret.Data["tls.key"] - TLS private key.
- Secret.Data["tls.crt"] - TLS certificate.
|===
=== .spec.servingCerts.namedCertificates[].servingCertificate
Description::
+
--
servingCertificate references a kubernetes.io/tls type secret containing the TLS cert info for serving secure traffic.
The secret must exist in the openshift-config namespace and contain the following required fields:
- Secret.Data["tls.key"] - TLS private key.
- Secret.Data["tls.crt"] - TLS certificate.
--
Type::
`object`
Required::
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `name`
| `string`
| name is the metadata.name of the referenced secret
|===
=== .spec.tlsSecurityProfile
Description::
+
--
tlsSecurityProfile specifies settings for TLS connections for externally exposed servers.
When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
The current default is the Intermediate profile.
--
Type::
`object`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `custom`
| ``
| custom is a user-defined TLS security profile. Be extremely careful using a custom
profile as invalid configurations can be catastrophic. An example custom profile
looks like this:
ciphers:
- ECDHE-ECDSA-CHACHA20-POLY1305
- ECDHE-RSA-CHACHA20-POLY1305
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES128-GCM-SHA256
minTLSVersion: VersionTLS11
| `intermediate`
| ``
| intermediate is a TLS security profile based on:
https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29
and looks like this (yaml):
ciphers:
- TLS_AES_128_GCM_SHA256
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- ECDHE-ECDSA-AES128-GCM-SHA256
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES256-GCM-SHA384
- ECDHE-RSA-AES256-GCM-SHA384
- ECDHE-ECDSA-CHACHA20-POLY1305
- ECDHE-RSA-CHACHA20-POLY1305
- DHE-RSA-AES128-GCM-SHA256
- DHE-RSA-AES256-GCM-SHA384
minTLSVersion: VersionTLS12
| `modern`
| ``
| modern is a TLS security profile based on:
https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility
and looks like this (yaml):
ciphers:
- TLS_AES_128_GCM_SHA256
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
minTLSVersion: VersionTLS13
| `old`
| ``
| old is a TLS security profile based on:
https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility
and looks like this (yaml):
ciphers:
- TLS_AES_128_GCM_SHA256
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- ECDHE-ECDSA-AES128-GCM-SHA256
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES256-GCM-SHA384
- ECDHE-RSA-AES256-GCM-SHA384
- ECDHE-ECDSA-CHACHA20-POLY1305
- ECDHE-RSA-CHACHA20-POLY1305
- DHE-RSA-AES128-GCM-SHA256
- DHE-RSA-AES256-GCM-SHA384
- DHE-RSA-CHACHA20-POLY1305
- ECDHE-ECDSA-AES128-SHA256
- ECDHE-RSA-AES128-SHA256
- ECDHE-ECDSA-AES128-SHA
- ECDHE-RSA-AES128-SHA
- ECDHE-ECDSA-AES256-SHA384
- ECDHE-RSA-AES256-SHA384
- ECDHE-ECDSA-AES256-SHA
- ECDHE-RSA-AES256-SHA
- DHE-RSA-AES128-SHA256
- DHE-RSA-AES256-SHA256
- AES128-GCM-SHA256
- AES256-GCM-SHA384
- AES128-SHA256
- AES256-SHA256
- AES128-SHA
- AES256-SHA
- DES-CBC3-SHA
minTLSVersion: VersionTLS10
| `type`
| `string`
| type is one of Old, Intermediate, Modern or Custom. Custom provides
the ability to specify individual TLS security profile parameters.
Old, Intermediate and Modern are TLS security profiles based on:
https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations
The profiles are intent based, so they may change over time as new ciphers are developed and existing ciphers
are found to be insecure. Depending on precisely which ciphers are available to a process, the list may be
reduced.
Note that the Modern profile is currently not supported because it is not
yet well adopted by common software libraries.
|===
=== .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/apiservers`
- `DELETE`: delete collection of APIServer
- `GET`: list objects of kind APIServer
- `POST`: create an APIServer
* `/apis/config.openshift.io/v1/apiservers/{name}`
- `DELETE`: delete an APIServer
- `GET`: read the specified APIServer
- `PATCH`: partially update the specified APIServer
- `PUT`: replace the specified APIServer
* `/apis/config.openshift.io/v1/apiservers/{name}/status`
- `GET`: read status of the specified APIServer
- `PATCH`: partially update status of the specified APIServer
- `PUT`: replace status of the specified APIServer
=== /apis/config.openshift.io/v1/apiservers
HTTP method::
`DELETE`
Description::
delete collection of APIServer
.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 APIServer
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-config-v1-APIServerList[`APIServerList`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`POST`
Description::
create an APIServer
.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/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 201 - Created
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 202 - Accepted
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/config.openshift.io/v1/apiservers/{name}
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the APIServer
|===
HTTP method::
`DELETE`
Description::
delete an APIServer
.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 APIServer
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update the specified APIServer
.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/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace the specified APIServer
.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/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 201 - Created
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
=== /apis/config.openshift.io/v1/apiservers/{name}/status
.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the APIServer
|===
HTTP method::
`GET`
Description::
read status of the specified APIServer
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PATCH`
Description::
partially update status of the specified APIServer
.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/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
HTTP method::
`PUT`
Description::
replace status of the specified APIServer
.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/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
|
|===
.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 201 - Created
| xref:../config_apis/apiserver-config-openshift-io-v1.adoc#apiserver-config-openshift-io-v1[`APIServer`] schema
| 401 - Unauthorized
| Empty
|===
View Git Blame Copy Permalink