# kube-apiserver Admission (v1)

kube-apiserver Admission (v1)Resource TypesAdmissionReviewAdmissionReviewAdmissionReview describes an admission review request/response.FieldDescriptionapiVersionstringadmission.k8s.io/v1kindstringAdmissionReviewrequestAdmissionRequestRequest describes the attributes for the admission request.responseAdmissionResponseResponse describes the attributes for the admission response.AdmissionRequestAppears in:AdmissionReviewAdmissionRequest describes the admission.Attributes for the admission request.FieldDescriptionuid [Required]k8s.io/apimachinery/pkg/types.UIDUID is an identifier for the individual request/response. It allows us to distinguish instances of requests which are otherwise identical (parallel requests, requests when earlier requests did not modify etc) The UID is meant to track the round trip (request/response) between the KAS and the WebHook, not the user request. It is suitable for correlating log entries between the webhook and apiserver, for either auditing or debugging.kind [Required]meta/v1.GroupVersionKindKind is the fully-qualified type of object being submitted (for example, v1.Pod or autoscaling.v1.Scale)resource [Required]meta/v1.GroupVersionResourceResource is the fully-qualified resource being requested (for example, v1.pods)subResourcestringSubResource is the subresource being requested, if any (for example, "status" or "scale")requestKindmeta/v1.GroupVersionKindRequestKind is the fully-qualified type of the original API request (for example, v1.Pod or autoscaling.v1.Scale). If this is specified and differs from the value in "kind", an equivalent match and conversion was performed.For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"] and matchPolicy: Equivalent, an API request to apps/v1beta1 deployments would be converted and sent to the webhook with kind: {group:"apps", version:"v1", kind:"Deployment"} (matching the rule the webhook registered for), and requestKind: {group:"apps", version:"v1beta1", kind:"Deployment"} (indicating the kind of the original API request).See documentation for the "matchPolicy" field in the webhook configuration type for more details.requestResourcemeta/v1.GroupVersionResourceRequestResource is the fully-qualified resource of the original API request (for example, v1.pods). If this is specified and differs from the value in "resource", an equivalent match and conversion was performed.For example, if deployments can be modified via apps/v1 and apps/v1beta1, and a webhook registered a rule of apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"] and matchPolicy: Equivalent, an API request to apps/v1beta1 deployments would be converted and sent to the webhook with resource: {group:"apps", version:"v1", resource:"deployments"} (matching the resource the webhook registered for), and requestResource: {group:"apps", version:"v1beta1", resource:"deployments"} (indicating the resource of the original API request).See documentation for the "matchPolicy" field in the webhook configuration type.requestSubResourcestringRequestSubResource is the name of the subresource of the original API request, if any (for example, "status" or "scale") If this is specified and differs from the value in "subResource", an equivalent match and conversion was performed. See documentation for the "matchPolicy" field in the webhook configuration type.namestringName is the name of the object as presented in the request. On a CREATE operation, the client may omit name and rely on the server to generate the name. If that is the case, this field will contain an empty string.namespacestringNamespace is the namespace associated with the request (if any).operation [Required]OperationOperation is the operation being performed. This may be different than the operation requested. e.g. a patch can result in either a CREATE or UPDATE Operation.userInfo [Required]authentication/v1.UserInfoUserInfo is information about the requesting userobjectk8s.io/apimachinery/pkg/runtime.RawExtensionObject is the object from the incoming request.oldObjectk8s.io/apimachinery/pkg/runtime.RawExtensionOldObject is the existing object. Only populated for DELETE and UPDATE requests.dryRunboolDryRun indicates that modifications will definitely not be persisted for this request. Defaults to false.optionsk8s.io/apimachinery/pkg/runtime.RawExtensionOptions is the operation option structure of the operation being performed. e.g. meta.k8s.io/v1.DeleteOptions or meta.k8s.io/v1.CreateOptions. This may be different than the options the caller provided. e.g. for a patch request the performed Operation might be a CREATE, in which case the Options will a meta.k8s.io/v1.CreateOptions even though the caller provided meta.k8s.io/v1.PatchOptions.AdmissionResponseAppears in:AdmissionReviewAdmissionResponse describes an admission response.FieldDescriptionuid [Required]k8s.io/apimachinery/pkg/types.UIDUID is an identifier for the individual request/response. This must be copied over from the corresponding AdmissionRequest.allowed [Required]boolAllowed indicates whether or not the admission request was permitted.statusmeta/v1.StatusResult contains extra details into why an admission request was denied. This field IS NOT consulted in any way if "Allowed" is "true".patch[]byteThe patch body. Currently we only support "JSONPatch" which implements RFC 6902.patchTypePatchTypeThe type of Patch. Currently we only allow "JSONPatch".auditAnnotationsmap[string]stringAuditAnnotations is an unstructured key value map set by remote admission controller (e.g. error=image-blacklisted). MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controller will prefix the keys with admission webhook name (e.g. imagepolicy.example.com/error=image-blacklisted). AuditAnnotations will be provided by the admission webhook to add additional context to the audit log for this request.warnings[]stringwarnings is a list of warning messages to return to the requesting API client. Warning messages describe a problem the client making the API request should correct or be aware of. Limit warnings to 120 characters if possible. Warnings over 256 characters and large numbers of warnings may be truncated.Operation(Alias of string)Appears in:AdmissionRequestOperation is the type of resource operation being checked for admission controlPatchType(Alias of string)Appears in:AdmissionResponsePatchType is the type of patch being used to represent the mutated objectThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.