# Get Kubernetes node pools

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/kubernetesnodepools/get/

`GET /unified/cloud-infrastructure/kubernetes_node_pools/{id}`

Resource: **KubernetesNodePools** · API: **Unified Cloud Infrastructure API**

## Supported integrations

Amazon Web Services

## Path parameters

- **`id`** _(string, required)_
  The ID of the resource.

## Query parameters

- **`integrated_account_id`** _(string, required)_
  The ID of the integrated account to use for the request.
- **`truto_response_format`** _(string)_
  The format of the response. - `unified` returns the response with unified mappings applied. - `raw` returns the unprocessed, raw response from the remote API. - `normalized` applies the unified mappings and returns the data in a normalized format. - `stream` returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory. - `debug` returns the final unified result alongside raw remote fetch information. The response is an envelope containing `result` (identical to unified mode output) and `debug` (with `requestUrl`, `requestOptions`, `data`, `responseHeaders`, and for list operations: `nextCursor`, `isLooping`, `isEmptyResult`, `resultCount`). When the upstream body exceeds 1 MiB, `data` is replaced by `{ truto_truncated: true, truto_max_bytes, truto_excerpt }`. `debug` is `null` for static responses or when `truto_skip_api_call=true`. Defaults to `unified`.
  Allowed: `unified`, `raw`, `normalized`, `stream`, `debug`
- **`truto_ignore_remote_data`** _(boolean)_
  Excludes the `remote_data` attribute from the response.
- **`truto_exclude_fields`** _(array<string>)_
  Array of fields to exclude from the response.
- **`remote_query`** _(object)_
  Query parameters to pass to the underlying API without any transformations. Refer [this guide](https://truto.one/docs/api-reference/overview/querying#remote-query-parameters) to see how to structure the query parameters.
- **`region`** _(string)_
  AWS region to read. One call reads one region; the caller drives any multi-region loop.
- **`cluster_id`** _(string)_
  The cluster ARN or name. Only needed with a bare node group name; the node group ARN names its cluster.

## Response body

- **`id`** _(string, required)_
  Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
- **`provider_id`** _(string)_
  The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
- **`provider`** _(string)_
  Which cloud this object was read from.
  Allowed: `aws`, `azure`, `gcp`
- **`account`** _(string)_
  The account, subscription or project this object belongs to.
- **`region`** _(string)_
  Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged in unreadable_fields.
- **`native_type`** _(string)_
  The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
- **`tags`** _(object)_
  Key-value pairs exactly as the customer set them: no case folding, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.
- **`collected_at`** _(string)_
  When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.
- **`updated_at`** _(string)_
  When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
- **`created_at`** _(string)_
  When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
- **`unreadable_fields`** _(array<object>)_
  Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.
  - **`field`** _(string)_
    The property on this resource that could not be read.
  - **`reason`** _(string)_
    Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.
    Allowed: `not_supported_by_provider`, `not_configured`, `permission_denied`, `not_collected`, `collection_error`, `partially_collected`, `available_on_get`
  - **`detail`** _(string)_
    Explanation of the reason, where one adds anything.
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.
- **`name`** _(string)_
  The node pool name, verbatim.
- **`status`** _(string)_
  State, normalised. failed: creating or deleting the pool failed (on AWS EKS: CREATE_FAILED, DELETE_FAILED). degraded: the pool runs but has a health issue - see health_issue_codes. provider_status has the provider's value verbatim.
  Allowed: `creating`, `active`, `updating`, `deleting`, `failed`, `degraded`, `unknown`
- **`provider_status`** _(string)_
  The provider's own state string, verbatim (on AWS EKS: CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, DELETE_FAILED, DEGRADED).
- **`cluster`** _(object)_
  The Kubernetes cluster the pool belongs to.
  - **`id`** _(string)_
    The target's `id`.
- **`kubernetes_version`** _(string)_
  The Kubernetes version of the nodes, verbatim. It can lag the cluster's kubernetes_version after a control-plane upgrade.
- **`node_image_version`** _(string)_
  The node image release, verbatim (on AWS EKS: the AMI release version, for example 1.31.0-20241011).
- **`node_image_type`** _(string)_
  The node image family, verbatim (on AWS EKS: the AMI type, for example AL2023_x86_64_STANDARD, BOTTLEROCKET_ARM_64, CUSTOM).
- **`capacity_type`** _(string)_
  How the nodes are bought, normalised. spot: spare capacity the provider can take back at short notice (Azure Spot, GCP Spot VMs). reserved_capacity: capacity booked ahead for a fixed period (on AWS: EC2 Capacity Blocks, CAPACITY_BLOCK). provider_capacity_type has the value verbatim.
  Allowed: `on_demand`, `spot`, `reserved_capacity`, `unknown`
- **`provider_capacity_type`** _(string)_
  How the nodes are bought, verbatim (on AWS EKS: ON_DEMAND, SPOT or CAPACITY_BLOCK).
- **`instance_types`** _(array<string>)_
  Instance types the pool launches.
- **`disk_size_gb`** _(integer)_
  Root volume size in GiB. Null when a launch template sets the disk.
- **`min_size`** _(integer)_
  Minimum node count.
- **`max_size`** _(integer)_
  Maximum node count.
- **`desired_size`** _(integer)_
  Desired node count.
- **`remote_access_enabled`** _(boolean)_
  Whether SSH (RDP on Windows) access to the nodes is configured with a key.
- **`remote_access_open_to_internet`** _(boolean)_
  True when remote access is configured with a key but no source rule sets: the provider then opens the port to 0.0.0.0/0.
- **`remote_access_source_rule_sets`** _(array<object>)_
  The firewall rule sets (security groups) allowed to reach the nodes over SSH/RDP.
  - **`id`** _(string)_
    The target's `id`.
- **`node_role`** _(object)_
  The role the nodes run as.
  - **`id`** _(string)_
    The target's `id`.
- **`subnet_ids`** _(array<string>)_
  Subnets the nodes are placed in.
- **`launch_template_id`** _(string)_
  The launch template the pool uses, when one is set.
- **`health_issue_codes`** _(array<string>)_
  Codes of the provider's current health issues for the pool. Empty means healthy.

## Code examples

### Truto CLI

```bash
truto unified cloud-infrastructure kubernetesnodepools '<resource_id>' \
  -m get \
  -a '<integrated_account_id>' \
  -o json
```

### Truto TS SDK

```typescript
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.get(
  'cloud-infrastructure',
  'kubernetesnodepools',
  '<resource_id>',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
```

### Truto Python SDK

```python
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.get(
        "cloud-infrastructure",
        "kubernetesnodepools",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
```

### curl

```bash
curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/kubernetes_node_pools/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
```

### JavaScript

```javascript
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/kubernetes_node_pools/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

url = "https://api.truto.one/unified/cloud-infrastructure/kubernetes_node_pools/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
```
