Skip to content

Node [v1]

Description
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
Type
`object`

Specification

Property Type Description
apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata ObjectMeta Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec object NodeSpec describes the attributes that a node is created with.
status object NodeStatus is information about the current status of a node.

.spec

Description
NodeSpec describes the attributes that a node is created with.
Type
`object`
Property Type Description
configSource object NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
externalID string Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDR string PodCIDR represents the pod IP range assigned to the node.
podCIDRs array (string) podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6.
providerID string ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
taints array If specified, the node’s taints.
taints[] object The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
unschedulable boolean Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration

.spec.configSource

Description
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
Type
`object`
Property Type Description
configMap object ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.spec.configSource.configMap

Description
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
Type
`object`
Required
  • namespace
  • name
  • kubeletConfigKey
Property Type Description
kubeletConfigKey string KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name string Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace string Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion string ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid string UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.spec.taints

Description
If specified, the node’s taints.
Type
`array`

.spec.taints[]

Description
The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
Type
`object`
Required
  • key
  • effect
Property Type Description
effect string Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
Possible enum values: - "NoExecute" Evict any already-running pods that do not tolerate the taint. Currently enforced by NodeController. - "NoSchedule" Do not allow new pods to schedule onto the node unless they tolerate the taint, but allow all pods submitted to Kubelet without going through the scheduler to start, and allow all already-running pods to continue running. Enforced by the scheduler. - "PreferNoSchedule" Like TaintEffectNoSchedule, but the scheduler tries not to schedule new pods onto the node, rather than prohibiting new pods from scheduling onto the node entirely. Enforced by the scheduler.
key string Required. The taint key to be applied to a node.
timeAdded Time TimeAdded represents the time at which the taint was added.
value string The taint value corresponding to the taint key.

.status

Description
NodeStatus is information about the current status of a node.
Type
`object`
Property Type Description
addresses array List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node’s address in its own status or consumers of the downward API (status.hostIP).
addresses[] object NodeAddress contains information for the node’s address.
allocatable object (Quantity) Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity object (Quantity) Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacity
conditions array Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
conditions[] object NodeCondition contains condition information for a node.
config object NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
daemonEndpoints object NodeDaemonEndpoints lists ports opened by daemons running on the Node.
declaredFeatures array (string) DeclaredFeatures represents the features related to feature gates that are declared by the node.
features object NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.
images array List of container images on this node
images[] object Describe a container image
nodeInfo object NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
phase string NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
Possible enum values: - "Pending" means the node has been created/added by the system, but not configured. - "Running" means the node has been configured and has Kubernetes components running. - "Terminated" means the node has been removed from the cluster.
runtimeHandlers array The available runtime handlers.
runtimeHandlers[] object NodeRuntimeHandler is a set of runtime handler information.
volumesAttached array List of volumes that are attached to the node.
volumesAttached[] object AttachedVolume describes a volume attached to a node
volumesInUse array (string) List of attachable volumes in use (mounted) by the node.

.status.addresses

Description
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node’s address in its own status or consumers of the downward API (status.hostIP).
Type
`array`

.status.addresses[]

Description
NodeAddress contains information for the node’s address.
Type
`object`
Required
  • type
  • address
Property Type Description
address string The node address.
type string Node address type, one of Hostname, ExternalIP or InternalIP.

.status.conditions

Description
Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
Type
`array`

.status.conditions[]

Description
NodeCondition contains condition information for a node.
Type
`object`
Required
  • type
  • status
Property Type Description
lastHeartbeatTime Time Last time we got an update on a given condition.
lastTransitionTime Time Last time the condition transit from one status to another.
message string Human readable message indicating details about last transition.
reason string (brief) reason for the condition’s last transition.
status string Status of the condition, one of True, False, Unknown.
type string Type of node condition.

.status.config

Description
NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.
Type
`object`
Property Type Description
active object NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
assigned object NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
error string Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.
lastKnownGood object NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

.status.config.active

Description
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
Type
`object`
Property Type Description
configMap object ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.status.config.active.configMap

Description
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
Type
`object`
Required
  • namespace
  • name
  • kubeletConfigKey
Property Type Description
kubeletConfigKey string KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name string Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace string Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion string ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid string UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.status.config.assigned

Description
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
Type
`object`
Property Type Description
configMap object ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.status.config.assigned.configMap

Description
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
Type
`object`
Required
  • namespace
  • name
  • kubeletConfigKey
Property Type Description
kubeletConfigKey string KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name string Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace string Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion string ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid string UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.status.config.lastKnownGood

Description
NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22
Type
`object`
Property Type Description
configMap object ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

.status.config.lastKnownGood.configMap

Description
ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
Type
`object`
Required
  • namespace
  • name
  • kubeletConfigKey
Property Type Description
kubeletConfigKey string KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name string Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace string Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion string ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid string UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

.status.daemonEndpoints

Description
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
Type
`object`
Property Type Description
kubeletEndpoint object DaemonEndpoint contains information about a single Daemon endpoint.

.status.daemonEndpoints.kubeletEndpoint

Description
DaemonEndpoint contains information about a single Daemon endpoint.
Type
`object`
Required
  • Port
Property Type Description
Port integer Port number of the given endpoint.

.status.features

Description
NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.
Type
`object`
Property Type Description
supplementalGroupsPolicy boolean SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.

.status.images

Description
List of container images on this node
Type
`array`

.status.images[]

Description
Describe a container image
Type
`object`
Property Type Description
names array (string) Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
sizeBytes integer The size of the image in bytes.

.status.nodeInfo

Description
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
Type
`object`
Required
  • machineID
  • systemUUID
  • bootID
  • kernelVersion
  • osImage
  • containerRuntimeVersion
  • kubeletVersion
  • kubeProxyVersion
  • operatingSystem
  • architecture
Property Type Description
architecture string The Architecture reported by the node
bootID string Boot ID reported by the node.
containerRuntimeVersion string ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
kernelVersion string Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeProxyVersion string Deprecated: KubeProxy Version reported by the node.
kubeletVersion string Kubelet Version reported by the node.
machineID string MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
operatingSystem string The Operating System reported by the node
osImage string OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
swap object NodeSwapStatus represents swap memory information.
systemUUID string SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid

.status.nodeInfo.swap

Description
NodeSwapStatus represents swap memory information.
Type
`object`
Property Type Description
capacity integer Total amount of swap memory in bytes.

.status.runtimeHandlers

Description
The available runtime handlers.
Type
`array`

.status.runtimeHandlers[]

Description
NodeRuntimeHandler is a set of runtime handler information.
Type
`object`
Property Type Description
features object NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
name string Runtime handler name. Empty for the default runtime handler.

.status.runtimeHandlers[].features

Description
NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.
Type
`object`
Property Type Description
recursiveReadOnlyMounts boolean RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
userNamespaces boolean UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.

.status.volumesAttached

Description
List of volumes that are attached to the node.
Type
`array`

.status.volumesAttached[]

Description
AttachedVolume describes a volume attached to a node
Type
`object`
Required
  • name
  • devicePath
Property Type Description
devicePath string DevicePath represents the device path where the volume should be available
name string Name of the attached volume

API endpoints

The following API endpoints are available:

  • /api/v1/nodes

    • DELETE: delete collection of Node
    • GET: list or watch objects of kind Node
    • POST: create a Node
  • /api/v1/watch/nodes

    • GET: watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.
  • /api/v1/nodes/{name}

    • DELETE: delete a Node
    • GET: read the specified Node
    • PATCH: partially update the specified Node
    • PUT: replace the specified Node
  • /api/v1/watch/nodes/{name}

    • GET: watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
  • /api/v1/nodes/{name}/status

    • GET: read status of the specified Node
    • PATCH: partially update status of the specified Node
    • PUT: replace status of the specified Node

/api/v1/nodes

HTTP method
`DELETE`
Description
delete collection of Node

Query parameters

Parameter Type Description
dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code Reponse body
200 - OK Status schema
401 - Unauthorized Empty
HTTP method
`GET`
Description
list or watch objects of kind Node

HTTP responses

HTTP code Reponse body
200 - OK NodeList schema
401 - Unauthorized Empty
HTTP method
`POST`
Description
create a Node

Query parameters

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

Body parameters

Parameter Type Description
body Node schema

HTTP responses

HTTP code Reponse body
200 - OK Node schema
201 - Created Node schema
202 - Accepted Node schema
401 - Unauthorized Empty

/api/v1/watch/nodes

HTTP method
`GET`
Description
watch individual changes to a list of Node. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.

HTTP responses

HTTP code Reponse body
200 - OK WatchEvent schema
401 - Unauthorized Empty

/api/v1/nodes/{name}

Global path parameters

Parameter Type Description
name string name of the Node
HTTP method
`DELETE`
Description
delete a Node

Query parameters

Parameter Type Description
dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code Reponse body
200 - OK Status schema
202 - Accepted Status schema
401 - Unauthorized Empty
HTTP method
`GET`
Description
read the specified Node

HTTP responses

HTTP code Reponse body
200 - OK Node schema
401 - Unauthorized Empty
HTTP method
`PATCH`
Description
partially update the specified Node

Query parameters

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

HTTP responses

HTTP code Reponse body
200 - OK Node schema
201 - Created Node schema
401 - Unauthorized Empty
HTTP method
`PUT`
Description
replace the specified Node

Query parameters

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

Body parameters

Parameter Type Description
body Node schema

HTTP responses

HTTP code Reponse body
200 - OK Node schema
201 - Created Node schema
401 - Unauthorized Empty

/api/v1/watch/nodes/{name}

Global path parameters

Parameter Type Description
name string name of the Node
HTTP method
`GET`
Description
watch changes to an object of kind Node. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead, filtered to a single item with the &#x27;fieldSelector&#x27; parameter.

HTTP responses

HTTP code Reponse body
200 - OK WatchEvent schema
401 - Unauthorized Empty

/api/v1/nodes/{name}/status

Global path parameters

Parameter Type Description
name string name of the Node
HTTP method
`GET`
Description
read status of the specified Node

HTTP responses

HTTP code Reponse body
200 - OK Node schema
401 - Unauthorized Empty
HTTP method
`PATCH`
Description
partially update status of the specified Node

Query parameters

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

HTTP responses

HTTP code Reponse body
200 - OK Node schema
201 - Created Node schema
401 - Unauthorized Empty
HTTP method
`PUT`
Description
replace status of the specified Node

Query parameters

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

Body parameters

Parameter Type Description
body Node schema

HTTP responses

HTTP code Reponse body
200 - OK Node schema
201 - Created Node schema
401 - Unauthorized Empty