Skip to main content

AdmissionregistrationV1Api

All URIs are relative to http://localhost

Mutating Admission Policy​

MethodHTTP requestDescription
createMutatingAdmissionPolicyPOST /apis/admissionregistration.k8s.io/v1/mutatingadmissionpoliciescreate a MutatingAdmissionPolicy
readMutatingAdmissionPolicyGET /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicies/{name}Generated API methods accept optional request options as a second argument.
listMutatingAdmissionPolicyGET /apis/admissionregistration.k8s.io/v1/mutatingadmissionpoliciesGenerated API methods accept optional request options as a second argument.
patchMutatingAdmissionPolicyPATCH /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicies/{name}partially update the specified MutatingAdmissionPolicy
replaceMutatingAdmissionPolicyPUT /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicies/{name}replace the specified MutatingAdmissionPolicy
deleteCollectionMutatingAdmissionPolicyDELETE /apis/admissionregistration.k8s.io/v1/mutatingadmissionpoliciesGenerated API methods accept optional request options as a second argument.
deleteMutatingAdmissionPolicyDELETE /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicies/{name}Generated API methods accept optional request options as a second argument.

Mutating Admission Policy Binding​

MethodHTTP requestDescription
createMutatingAdmissionPolicyBindingPOST /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindingscreate a MutatingAdmissionPolicyBinding
readMutatingAdmissionPolicyBindingGET /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindings/{name}Generated API methods accept optional request options as a second argument.
listMutatingAdmissionPolicyBindingGET /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindingsGenerated API methods accept optional request options as a second argument.
patchMutatingAdmissionPolicyBindingPATCH /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindings/{name}partially update the specified MutatingAdmissionPolicyBinding
replaceMutatingAdmissionPolicyBindingPUT /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindings/{name}replace the specified MutatingAdmissionPolicyBinding
deleteCollectionMutatingAdmissionPolicyBindingDELETE /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindingsGenerated API methods accept optional request options as a second argument.
deleteMutatingAdmissionPolicyBindingDELETE /apis/admissionregistration.k8s.io/v1/mutatingadmissionpolicybindings/{name}Generated API methods accept optional request options as a second argument.

Mutating Webhook Configuration​

MethodHTTP requestDescription
createMutatingWebhookConfigurationPOST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurationscreate a MutatingWebhookConfiguration
readMutatingWebhookConfigurationGET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}Generated API methods accept optional request options as a second argument.
listMutatingWebhookConfigurationGET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurationsGenerated API methods accept optional request options as a second argument.
patchMutatingWebhookConfigurationPATCH /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}partially update the specified MutatingWebhookConfiguration
replaceMutatingWebhookConfigurationPUT /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}replace the specified MutatingWebhookConfiguration
deleteCollectionMutatingWebhookConfigurationDELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurationsGenerated API methods accept optional request options as a second argument.
deleteMutatingWebhookConfigurationDELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}Generated API methods accept optional request options as a second argument.

Validating Admission Policy​

MethodHTTP requestDescription
createValidatingAdmissionPolicyPOST /apis/admissionregistration.k8s.io/v1/validatingadmissionpoliciescreate a ValidatingAdmissionPolicy
readValidatingAdmissionPolicyGET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}Generated API methods accept optional request options as a second argument.
listValidatingAdmissionPolicyGET /apis/admissionregistration.k8s.io/v1/validatingadmissionpoliciesGenerated API methods accept optional request options as a second argument.
readValidatingAdmissionPolicyStatusGET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/statusGenerated API methods accept optional request options as a second argument.
patchValidatingAdmissionPolicyPATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}partially update the specified ValidatingAdmissionPolicy
patchValidatingAdmissionPolicyStatusPATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/statuspartially update status of the specified ValidatingAdmissionPolicy
replaceValidatingAdmissionPolicyPUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}replace the specified ValidatingAdmissionPolicy
deleteCollectionValidatingAdmissionPolicyDELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpoliciesGenerated API methods accept optional request options as a second argument.
deleteValidatingAdmissionPolicyDELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}Generated API methods accept optional request options as a second argument.
replaceValidatingAdmissionPolicyStatusPUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/statusreplace status of the specified ValidatingAdmissionPolicy

Validating Admission Policy Binding​

MethodHTTP requestDescription
createValidatingAdmissionPolicyBindingPOST /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindingscreate a ValidatingAdmissionPolicyBinding
readValidatingAdmissionPolicyBindingGET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}Generated API methods accept optional request options as a second argument.
listValidatingAdmissionPolicyBindingGET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindingsGenerated API methods accept optional request options as a second argument.
patchValidatingAdmissionPolicyBindingPATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}partially update the specified ValidatingAdmissionPolicyBinding
replaceValidatingAdmissionPolicyBindingPUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}replace the specified ValidatingAdmissionPolicyBinding
deleteCollectionValidatingAdmissionPolicyBindingDELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindingsGenerated API methods accept optional request options as a second argument.
deleteValidatingAdmissionPolicyBindingDELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name}Generated API methods accept optional request options as a second argument.

Validating Webhook Configuration​

MethodHTTP requestDescription
createValidatingWebhookConfigurationPOST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurationscreate a ValidatingWebhookConfiguration
readValidatingWebhookConfigurationGET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}Generated API methods accept optional request options as a second argument.
listValidatingWebhookConfigurationGET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurationsGenerated API methods accept optional request options as a second argument.
patchValidatingWebhookConfigurationPATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}partially update the specified ValidatingWebhookConfiguration
replaceValidatingWebhookConfigurationPUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}replace the specified ValidatingWebhookConfiguration
deleteCollectionValidatingWebhookConfigurationDELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurationsGenerated API methods accept optional request options as a second argument.
deleteValidatingWebhookConfigurationDELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}Generated API methods accept optional request options as a second argument.

APIResources​

MethodHTTP requestDescription
getAPIResourcesGET /apis/admissionregistration.k8s.io/v1/Generated API methods accept optional request options as a second argument.

Mutating Admission Policy​

createMutatingAdmissionPolicy​

V1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body)

create a MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiCreateMutatingAdmissionPolicyRequest = {
body: { /* See V1MutatingAdmissionPolicy: /models/other#v1mutatingadmissionpolicy */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.createMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1MutatingAdmissionPolicy
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicy

readMutatingAdmissionPolicy​

V1MutatingAdmissionPolicy readMutatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

read the specified MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadMutatingAdmissionPolicyRequest = {
// name of the MutatingAdmissionPolicy
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the MutatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicy

listMutatingAdmissionPolicy​

V1MutatingAdmissionPolicyList listMutatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiListMutatingAdmissionPolicyRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};

const data = await apiInstance.listMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
allowWatchBookmarks[boolean]allowWatchBookmarks requests watch events with type "BOOKMARK". More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
watch[boolean]Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicyList

patchMutatingAdmissionPolicy​

V1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body)

partially update the specified MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchMutatingAdmissionPolicyRequest = {
// name of the MutatingAdmissionPolicy
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the MutatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicy

replaceMutatingAdmissionPolicy​

V1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body)

replace the specified MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceMutatingAdmissionPolicyRequest = {
// name of the MutatingAdmissionPolicy
name: "name_example",
body: { /* See V1MutatingAdmissionPolicy: /models/other#v1mutatingadmissionpolicy */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1MutatingAdmissionPolicy
name[string]name of the MutatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicy

deleteCollectionMutatingAdmissionPolicy​

V1Status deleteCollectionMutatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

delete collection of MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteCollectionMutatingAdmissionPolicyRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// 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 (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
Return type​

V1Status

deleteMutatingAdmissionPolicy​

V1Status deleteMutatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

delete a MutatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteMutatingAdmissionPolicyRequest = {
// name of the MutatingAdmissionPolicy
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};

const data = await apiInstance.deleteMutatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the MutatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

Mutating Admission Policy Binding​

createMutatingAdmissionPolicyBinding​

V1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body)

create a MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiCreateMutatingAdmissionPolicyBindingRequest = {
body: { /* See V1MutatingAdmissionPolicyBinding: /models/other#v1mutatingadmissionpolicybinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.createMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1MutatingAdmissionPolicyBinding
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicyBinding

readMutatingAdmissionPolicyBinding​

V1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

read the specified MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadMutatingAdmissionPolicyBindingRequest = {
// name of the MutatingAdmissionPolicyBinding
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the MutatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicyBinding

listMutatingAdmissionPolicyBinding​

V1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiListMutatingAdmissionPolicyBindingRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};

const data = await apiInstance.listMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
allowWatchBookmarks[boolean]allowWatchBookmarks requests watch events with type "BOOKMARK". More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
watch[boolean]Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicyBindingList

patchMutatingAdmissionPolicyBinding​

V1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body)

partially update the specified MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchMutatingAdmissionPolicyBindingRequest = {
// name of the MutatingAdmissionPolicyBinding
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the MutatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicyBinding

replaceMutatingAdmissionPolicyBinding​

V1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body)

replace the specified MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceMutatingAdmissionPolicyBindingRequest = {
// name of the MutatingAdmissionPolicyBinding
name: "name_example",
body: { /* See V1MutatingAdmissionPolicyBinding: /models/other#v1mutatingadmissionpolicybinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1MutatingAdmissionPolicyBinding
name[string]name of the MutatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1MutatingAdmissionPolicyBinding

deleteCollectionMutatingAdmissionPolicyBinding​

V1Status deleteCollectionMutatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

delete collection of MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// 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 (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
Return type​

V1Status

deleteMutatingAdmissionPolicyBinding​

V1Status deleteMutatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

delete a MutatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteMutatingAdmissionPolicyBindingRequest = {
// name of the MutatingAdmissionPolicyBinding
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};

const data = await apiInstance.deleteMutatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the MutatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

Mutating Webhook Configuration​

createMutatingWebhookConfiguration​

V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body)

create a MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = {
body: { /* See V1MutatingWebhookConfiguration: /models/cluster#v1mutatingwebhookconfiguration */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.createMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1MutatingWebhookConfiguration
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1MutatingWebhookConfiguration

readMutatingWebhookConfiguration​

V1MutatingWebhookConfiguration readMutatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

read the specified MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the MutatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1MutatingWebhookConfiguration

listMutatingWebhookConfiguration​

V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};

const data = await apiInstance.listMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
allowWatchBookmarks[boolean]allowWatchBookmarks requests watch events with type "BOOKMARK". More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
watch[boolean]Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info(optional) defaults to undefined
Return type​

V1MutatingWebhookConfigurationList

patchMutatingWebhookConfiguration​

V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body)

partially update the specified MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the MutatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1MutatingWebhookConfiguration

replaceMutatingWebhookConfiguration​

V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body)

replace the specified MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
name: "name_example",
body: { /* See V1MutatingWebhookConfiguration: /models/cluster#v1mutatingwebhookconfiguration */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1MutatingWebhookConfiguration
name[string]name of the MutatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1MutatingWebhookConfiguration

deleteCollectionMutatingWebhookConfiguration​

V1Status deleteCollectionMutatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

delete collection of MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// 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 (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
Return type​

V1Status

deleteMutatingWebhookConfiguration​

V1Status deleteMutatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

delete a MutatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};

const data = await apiInstance.deleteMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the MutatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

Validating Admission Policy​

createValidatingAdmissionPolicy​

V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body)

create a ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = {
body: { /* See V1ValidatingAdmissionPolicy: /models/cluster#v1validatingadmissionpolicy */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.createValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingAdmissionPolicy
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

readValidatingAdmissionPolicy​

V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

read the specified ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

listValidatingAdmissionPolicy​

V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};

const data = await apiInstance.listValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
allowWatchBookmarks[boolean]allowWatchBookmarks requests watch events with type "BOOKMARK". More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
watch[boolean]Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicyList

readValidatingAdmissionPolicyStatus​

V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus()

Generated API methods accept optional request options as a second argument.

read status of the specified ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readValidatingAdmissionPolicyStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

patchValidatingAdmissionPolicy​

V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body)

partially update the specified ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

patchValidatingAdmissionPolicyStatus​

V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body)

partially update status of the specified ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchValidatingAdmissionPolicyStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

replaceValidatingAdmissionPolicy​

V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body)

replace the specified ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
body: { /* See V1ValidatingAdmissionPolicy: /models/cluster#v1validatingadmissionpolicy */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingAdmissionPolicy
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

deleteCollectionValidatingAdmissionPolicy​

V1Status deleteCollectionValidatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

delete collection of ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// 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 (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
Return type​

V1Status

deleteValidatingAdmissionPolicy​

V1Status deleteValidatingAdmissionPolicy()

Generated API methods accept optional request options as a second argument.

delete a ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};

const data = await apiInstance.deleteValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

replaceValidatingAdmissionPolicyStatus​

V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body)

replace status of the specified ValidatingAdmissionPolicy

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
body: { /* See V1ValidatingAdmissionPolicy: /models/cluster#v1validatingadmissionpolicy */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceValidatingAdmissionPolicyStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingAdmissionPolicy
name[string]name of the ValidatingAdmissionPolicydefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicy

Validating Admission Policy Binding​

createValidatingAdmissionPolicyBinding​

V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body)

create a ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = {
body: { /* See V1ValidatingAdmissionPolicyBinding: /models/cluster#v1validatingadmissionpolicybinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.createValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingAdmissionPolicyBinding
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicyBinding

readValidatingAdmissionPolicyBinding​

V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

read the specified ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the ValidatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicyBinding

listValidatingAdmissionPolicyBinding​

V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};

const data = await apiInstance.listValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
allowWatchBookmarks[boolean]allowWatchBookmarks requests watch events with type "BOOKMARK". More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
watch[boolean]Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicyBindingList

patchValidatingAdmissionPolicyBinding​

V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body)

partially update the specified ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the ValidatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicyBinding

replaceValidatingAdmissionPolicyBinding​

V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body)

replace the specified ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
name: "name_example",
body: { /* See V1ValidatingAdmissionPolicyBinding: /models/cluster#v1validatingadmissionpolicybinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingAdmissionPolicyBinding
name[string]name of the ValidatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingAdmissionPolicyBinding

deleteCollectionValidatingAdmissionPolicyBinding​

V1Status deleteCollectionValidatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

delete collection of ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// 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 (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
Return type​

V1Status

deleteValidatingAdmissionPolicyBinding​

V1Status deleteValidatingAdmissionPolicyBinding()

Generated API methods accept optional request options as a second argument.

delete a ValidatingAdmissionPolicyBinding

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};

const data = await apiInstance.deleteValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the ValidatingAdmissionPolicyBindingdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

Validating Webhook Configuration​

createValidatingWebhookConfiguration​

V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body)

create a ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = {
body: { /* See V1ValidatingWebhookConfiguration: /models/cluster#v1validatingwebhookconfiguration */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.createValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingWebhookConfiguration
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingWebhookConfiguration

readValidatingWebhookConfiguration​

V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

read the specified ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};

const data = await apiInstance.readValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
name[string]name of the ValidatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
Return type​

V1ValidatingWebhookConfiguration

listValidatingWebhookConfiguration​

V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

list or watch objects of kind ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};

const data = await apiInstance.listValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
allowWatchBookmarks[boolean]allowWatchBookmarks requests watch events with type "BOOKMARK". More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
watch[boolean]Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info(optional) defaults to undefined
Return type​

V1ValidatingWebhookConfigurationList

patchValidatingWebhookConfiguration​

V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body)

partially update the specified ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};

const data = await apiInstance.patchValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyany
name[string]name of the ValidatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
force[boolean]Force is going to "force" Apply requests. More info(optional) defaults to undefined
Return type​

V1ValidatingWebhookConfiguration

replaceValidatingWebhookConfiguration​

V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body)

replace the specified ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
name: "name_example",
body: { /* See V1ValidatingWebhookConfiguration: /models/cluster#v1validatingwebhookconfiguration */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};

const data = await apiInstance.replaceValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1ValidatingWebhookConfiguration
name[string]name of the ValidatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldManager[string]fieldManager is a name associated with the actor or entity that is making these changes. More info(optional) defaults to undefined
fieldValidation[string]fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info(optional) defaults to undefined
Return type​

V1ValidatingWebhookConfiguration

deleteCollectionValidatingWebhookConfiguration​

V1Status deleteCollectionValidatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

delete collection of ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// 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 (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};

const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
_continue[string]The continue option should be set when retrieving more results from the server. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
fieldSelector[string]A selector to restrict the list of returned objects by their fields. Defaults to everything. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
labelSelector[string]A selector to restrict the list of returned objects by their labels. Defaults to everything. More info(optional) defaults to undefined
limit[number]limit is a maximum number of responses to return for a list call. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
resourceVersion[string]resourceVersion sets a constraint on what resource versions a request may be served from. More info(optional) defaults to undefined
resourceVersionMatch[string]resourceVersionMatch determines how resourceVersion is applied to list calls. More info(optional) defaults to undefined
sendInitialEvents[boolean]sendInitialEvents=true may be set together with watch=true. More info(optional) defaults to undefined
shardSelector[string]shardSelector restricts the list of returned objects using a CEL-based shard selector expression.(optional) defaults to undefined
timeoutSeconds[number]Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info(optional) defaults to undefined
Return type​

V1Status

deleteValidatingWebhookConfiguration​

V1Status deleteValidatingWebhookConfiguration()

Generated API methods accept optional request options as a second argument.

delete a ValidatingWebhookConfiguration

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// 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 (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};

const data = await apiInstance.deleteValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters​
NameTypeDescriptionNotes
bodyV1DeleteOptions
name[string]name of the ValidatingWebhookConfigurationdefaults to undefined
pretty[string]If 'true', then the output is pretty printed. More info(optional) defaults to undefined
dryRun[string]When present, indicates that modifications should not be persisted. More info(optional) defaults to undefined
gracePeriodSeconds[number]The duration in seconds before the object should be deleted. More info(optional) defaults to undefined
ignoreStoreReadErrorWithClusterBreakingPotential[boolean]if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info(optional) defaults to undefined
orphanDependents[boolean]Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info(optional) defaults to undefined
propagationPolicy[string]Whether and how garbage collection will be performed. More info(optional) defaults to undefined
Return type​

V1Status

APIResources​

getAPIResources​

V1APIResourceList getAPIResources()

Generated API methods accept optional request options as a second argument.

get available resources

Example​
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);

const request = {};

const data = await apiInstance.getAPIResources(request);
console.log('API called successfully. Returned data:', data);
Parameters​

This endpoint does not need any parameter.

Return type​

V1APIResourceList