---
title: "Get Kubernetes cluster nodes"
method: GET
path: "/kubernetes/{id}/nodes"
tags: ["kubernetes"]
---

# Get Kubernetes cluster nodes

`GET /kubernetes/{id}/nodes`

Returns the list of Kubernetes nodes for the selected environment.
**Access policy**: Authenticated user.

## Path parameters

- `id` integer, required

## Response `200`

Success

- KubernetesKubernetesNodeResponse[]
  - `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 +optional
  - `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 +optional
  - `metadata` V1ObjectMeta
    - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +optional
    - `creationTimestamp` string — CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional
    - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional
    - `deletionTimestamp` string — DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional
    - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge +listType=set
    - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional
    - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional
    - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +optional
    - `managedFields` V1ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional +listType=atomic
      - `apiVersion` string — APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
      - `fieldsType` string — FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
      - `fieldsV1` V1FieldsV1
      - `manager` string — Manager is an identifier of the workflow managing these fields.
      - `operation` 'Apply' | 'Update'
      - `subresource` string — Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
      - `time` string — Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional
    - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +optional
    - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +optional
    - `ownerReferences` V1OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge +listType=map +listMapKey=uid
      - `apiVersion` string — API version of the referent.
      - `blockOwnerDeletion` boolean — If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional
      - `controller` boolean — If true, this reference points to the managing controller. +optional
      - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
      - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
    - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional
    - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional
    - `uid` string — UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids +optional
  - `spec` V1NodeSpec
    - `configSource` V1NodeConfigSource
      - `configMap` V1ConfigMapNodeConfigSource
        - `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. +optional
        - `uid` string — UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional
    - `externalID` string — Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 +optional
    - `podCIDR` string — PodCIDR represents the pod IP range assigned to the node. +optional
    - `podCIDRs` 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. +optional +patchStrategy=merge +listType=set
    - `providerID` string — ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> +optional
    - `taints` V1Taint[] — If specified, the node's taints. +optional +listType=atomic
      - `effect` 'NoSchedule' | 'PreferNoSchedule' | 'NoExecute'
      - `key` string — Required. The taint key to be applied to a node.
      - `timeAdded` string — TimeAdded represents the time at which the taint was added. +optional
      - `value` string — The taint value corresponding to the taint key. +optional
    - `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 +optional
  - `status` V1NodeStatus
    - `addresses` V1NodeAddress[] — 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). +optional +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type
      - `address` string — The node address.
      - `type` 'Hostname' | 'InternalIP' | 'ExternalIP' | 'InternalDNS' | 'ExternalDNS'
    - `allocatable` V1ResourceList
    - `capacity` V1ResourceList
    - `conditions` V1NodeCondition[] — Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition +optional +patchMergeKey=type +patchStrategy=merge +listType=map +listMapKey=type
      - `lastHeartbeatTime` string — Last time we got an update on a given condition. +optional
      - `lastTransitionTime` string — Last time the condition transit from one status to another. +optional
      - `message` string — Human readable message indicating details about last transition. +optional
      - `reason` string — (brief) reason for the condition's last transition. +optional
      - `status` 'True' | 'False' | 'Unknown'
      - `type` 'Ready' | 'MemoryPressure' | 'DiskPressure' | 'PIDPressure' | 'NetworkUnavailable'
    - `config` V1NodeConfigStatus
      - `active` V1NodeConfigSource
        - `configMap` V1ConfigMapNodeConfigSource
          - `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. +optional
          - `uid` string — UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional
      - `assigned` V1NodeConfigSource
        - `configMap` V1ConfigMapNodeConfigSource
          - `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. +optional
          - `uid` string — UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional
      - `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. +optional
      - `lastKnownGood` V1NodeConfigSource
        - `configMap` V1ConfigMapNodeConfigSource
          - `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. +optional
          - `uid` string — UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. +optional
    - `daemonEndpoints` V1NodeDaemonEndpoints
      - `kubeletEndpoint` V1DaemonEndpoint
        - `Port` integer — Port number of the given endpoint.
    - `declaredFeatures` string[] — DeclaredFeatures represents the features related to feature gates that are declared by the node. +featureGate=NodeDeclaredFeatures +optional +listType=atomic
    - `features` V1NodeFeatures
      - `supplementalGroupsPolicy` boolean — SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser. +optional
    - `images` V1ContainerImage[] — List of container images on this node +optional +listType=atomic
      - `names` 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"] +optional +listType=atomic
      - `sizeBytes` integer — The size of the image in bytes. +optional
    - `nodeInfo` V1NodeSystemInfo
      - `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` V1NodeSwapStatus
        - `capacity` integer — Total amount of swap memory in bytes. +optional
      - `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
    - `phase` 'Pending' | 'Running' | 'Terminated'
    - `runtimeHandlers` V1NodeRuntimeHandler[] — The available runtime handlers. +featureGate=UserNamespacesSupport +optional +listType=atomic
      - `features` V1NodeRuntimeHandlerFeatures
        - `recursiveReadOnlyMounts` boolean — RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts. +optional
        - `userNamespaces` boolean — UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes. +featureGate=UserNamespacesSupport +optional
      - `name` string — Runtime handler name. Empty for the default runtime handler. +optional
    - `volumesAttached` V1AttachedVolume[] — List of volumes that are attached to the node. +optional +listType=atomic
      - `devicePath` string — DevicePath represents the device path where the volume should be available
      - `name` string — Name of the attached volume
    - `volumesInUse` string[] — List of attachable volumes in use (mounted) by the node. +optional +listType=atomic

## Other responses

- `401` — Unauthorized access - the user is not authenticated or does not have the necessary permissions.
- `403` — Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource.
- `500` — Server error occurred while attempting to retrieve the list of nodes.

---

[API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/ec51a8194ac0/schema)