AdmissionregistrationV1beta1Api

All URIs are relative to http://localhost

Mutating Admission Policy

Method	HTTP request	Description
createMutatingAdmissionPolicy	POST /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies	create a MutatingAdmissionPolicy
readMutatingAdmissionPolicy	GET /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name}	read the specified MutatingAdmissionPolicy
listMutatingAdmissionPolicy	GET /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies	list or watch objects of kind MutatingAdmissionPolicy
patchMutatingAdmissionPolicy	PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name}	partially update the specified MutatingAdmissionPolicy
replaceMutatingAdmissionPolicy	PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name}	replace the specified MutatingAdmissionPolicy
deleteCollectionMutatingAdmissionPolicy	DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies	delete collection of MutatingAdmissionPolicy
deleteMutatingAdmissionPolicy	DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicies/{name}	delete a MutatingAdmissionPolicy

Mutating Admission Policy Binding

Method	HTTP request	Description
createMutatingAdmissionPolicyBinding	POST /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings	create a MutatingAdmissionPolicyBinding
readMutatingAdmissionPolicyBinding	GET /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name}	read the specified MutatingAdmissionPolicyBinding
listMutatingAdmissionPolicyBinding	GET /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings	list or watch objects of kind MutatingAdmissionPolicyBinding
patchMutatingAdmissionPolicyBinding	PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name}	partially update the specified MutatingAdmissionPolicyBinding
replaceMutatingAdmissionPolicyBinding	PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name}	replace the specified MutatingAdmissionPolicyBinding
deleteCollectionMutatingAdmissionPolicyBinding	DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings	delete collection of MutatingAdmissionPolicyBinding
deleteMutatingAdmissionPolicyBinding	DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingadmissionpolicybindings/{name}	delete a MutatingAdmissionPolicyBinding

APIResources

Method	HTTP request	Description
getAPIResources	GET /apis/admissionregistration.k8s.io/v1beta1/	get available resources

Mutating Admission Policy

createMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicy createMutatingAdmissionPolicy(body)

create a MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyRequest = {
  body: { /* See V1beta1MutatingAdmissionPolicy: /models/other#v1beta1mutatingadmissionpolicy */ },
    // 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

Name	Type	Description	Notes
body	V1beta1MutatingAdmissionPolicy
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

V1beta1MutatingAdmissionPolicy

readMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicy readMutatingAdmissionPolicy()

read the specified MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyRequest = {
    // 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

Name	Type	Description	Notes
name	[string]	name of the MutatingAdmissionPolicy	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1beta1MutatingAdmissionPolicy

listMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicyList listMutatingAdmissionPolicy()

list or watch objects of kind MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyRequest = {
    // 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",
  // ...8 more optional parameter(s)
};

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

Parameters

Name	Type	Description	Notes
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
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

V1beta1MutatingAdmissionPolicyList

patchMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicy patchMutatingAdmissionPolicy(body)

partially update the specified MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyRequest = {
    // 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

Name	Type	Description	Notes
body	any
name	[string]	name of the MutatingAdmissionPolicy	defaults 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

V1beta1MutatingAdmissionPolicy

replaceMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicy replaceMutatingAdmissionPolicy(body)

replace the specified MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyRequest = {
    // name of the MutatingAdmissionPolicy
  name: "name_example",
  body: { /* See V1beta1MutatingAdmissionPolicy: /models/other#v1beta1mutatingadmissionpolicy */ },
    // 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

Name	Type	Description	Notes
body	V1beta1MutatingAdmissionPolicy
name	[string]	name of the MutatingAdmissionPolicy	defaults 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

V1beta1MutatingAdmissionPolicy

deleteCollectionMutatingAdmissionPolicy

V1Status deleteCollectionMutatingAdmissionPolicy()

delete collection of MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyRequest = {
    // 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 */ },
  // ...11 more optional parameter(s)
};

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
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
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()

delete a MutatingAdmissionPolicy

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyRequest = {
    // 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

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the MutatingAdmissionPolicy	defaults 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

V1beta1MutatingAdmissionPolicyBinding createMutatingAdmissionPolicyBinding(body)

create a MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiCreateMutatingAdmissionPolicyBindingRequest = {
  body: { /* See V1beta1MutatingAdmissionPolicyBinding: /models/other#v1beta1mutatingadmissionpolicybinding */ },
    // 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

Name	Type	Description	Notes
body	V1beta1MutatingAdmissionPolicyBinding
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

V1beta1MutatingAdmissionPolicyBinding

readMutatingAdmissionPolicyBinding

V1beta1MutatingAdmissionPolicyBinding readMutatingAdmissionPolicyBinding()

read the specified MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiReadMutatingAdmissionPolicyBindingRequest = {
    // 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

Name	Type	Description	Notes
name	[string]	name of the MutatingAdmissionPolicyBinding	defaults to undefined
pretty	[string]	If 'true', then the output is pretty printed. More info	(optional) defaults to undefined

Return type

V1beta1MutatingAdmissionPolicyBinding

listMutatingAdmissionPolicyBinding

V1beta1MutatingAdmissionPolicyBindingList listMutatingAdmissionPolicyBinding()

list or watch objects of kind MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiListMutatingAdmissionPolicyBindingRequest = {
    // 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",
  // ...8 more optional parameter(s)
};

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

Parameters

Name	Type	Description	Notes
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
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

V1beta1MutatingAdmissionPolicyBindingList

patchMutatingAdmissionPolicyBinding

V1beta1MutatingAdmissionPolicyBinding patchMutatingAdmissionPolicyBinding(body)

partially update the specified MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiPatchMutatingAdmissionPolicyBindingRequest = {
    // 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

Name	Type	Description	Notes
body	any
name	[string]	name of the MutatingAdmissionPolicyBinding	defaults 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

V1beta1MutatingAdmissionPolicyBinding

replaceMutatingAdmissionPolicyBinding

V1beta1MutatingAdmissionPolicyBinding replaceMutatingAdmissionPolicyBinding(body)

replace the specified MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiReplaceMutatingAdmissionPolicyBindingRequest = {
    // name of the MutatingAdmissionPolicyBinding
  name: "name_example",
  body: { /* See V1beta1MutatingAdmissionPolicyBinding: /models/other#v1beta1mutatingadmissionpolicybinding */ },
    // 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

Name	Type	Description	Notes
body	V1beta1MutatingAdmissionPolicyBinding
name	[string]	name of the MutatingAdmissionPolicyBinding	defaults 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

V1beta1MutatingAdmissionPolicyBinding

deleteCollectionMutatingAdmissionPolicyBinding

V1Status deleteCollectionMutatingAdmissionPolicyBinding()

delete collection of MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiDeleteCollectionMutatingAdmissionPolicyBindingRequest = {
    // 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 */ },
  // ...11 more optional parameter(s)
};

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

Parameters

Name	Type	Description	Notes
body	V1DeleteOptions
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
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()

delete a MutatingAdmissionPolicyBinding

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';

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

const request: AdmissionregistrationV1beta1ApiDeleteMutatingAdmissionPolicyBindingRequest = {
    // 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

Name	Type	Description	Notes
body	V1DeleteOptions
name	[string]	name of the MutatingAdmissionPolicyBinding	defaults 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()

get available resources

Example

import { createConfiguration, AdmissionregistrationV1beta1Api } from '@kubernetes/client-node';

const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1beta1Api(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