List Kubernetes node pools
/unified/cloud-infrastructure/kubernetes_node_pools
Query Parameters
Refer Specifying query parameters in Truto APIs
Required. The kubernetes_clusters id (cluster ARN) or the cluster name.
1 supported1 required
AWS region to read. One call reads one region; the caller drives any multi-region loop.
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Kubernetes node pools
Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
1 supported
The account, subscription or project this object belongs to.
1 supported
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.
on_demandspotreserved_capacityunknown
1 supported
The Kubernetes cluster the pool belongs to.
1 supported
1 property
The target's id.
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.
1 supported
When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
1 supported
Desired node count.
1 supported
Root volume size in GiB. Null when a launch template sets the disk.
1 supported
Codes of the provider's current health issues for the pool. Empty means healthy.
1 supported
Instance types the pool launches.
1 supported
The Kubernetes version of the nodes, verbatim. It can lag the cluster's kubernetes_version after a control-plane upgrade.
1 supported
The launch template the pool uses, when one is set.
1 supported
Maximum node count.
1 supported
Minimum node count.
1 supported
The node pool name, verbatim.
1 supported
The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
1 supported
The node image family, verbatim (on AWS EKS: the AMI type, for example AL2023_x86_64_STANDARD, BOTTLEROCKET_ARM_64, CUSTOM).
1 supported
The node image release, verbatim (on AWS EKS: the AMI release version, for example 1.31.0-20241011).
1 supported
The role the nodes run as.
1 supported
1 property
The target's id.
Which cloud this object was read from.
awsazuregcp
1 supported
How the nodes are bought, verbatim (on AWS EKS: ON_DEMAND, SPOT or CAPACITY_BLOCK).
1 supported
The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
1 supported
The provider's own state string, verbatim (on AWS EKS: CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, DELETE_FAILED, DEGRADED).
1 supported
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.
1 supported
Whether SSH (RDP on Windows) access to the nodes is configured with a key.
1 supported
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.
1 supported
The firewall rule sets (security groups) allowed to reach the nodes over SSH/RDP.
1 supported
1 property
The target's id.
Raw data returned from the remote API call.
1 supported
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.
creatingactiveupdatingdeletingfaileddegradedunknown
1 supported
Subnets the nodes are placed in.
1 supported
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.
1 supported
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.
1 supported
3 properties
Explanation of the reason, where one adds anything.
The property on this resource that could not be read.
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.
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
1 supported
truto unified cloud-infrastructure kubernetesnodepools \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'cloud-infrastructure',
'kubernetesnodepools',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"cloud-infrastructure",
"kubernetesnodepools",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/kubernetes_node_pools?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/kubernetes_node_pools?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/cloud-infrastructure/kubernetes_node_pools"
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())