Infomaniak Public Cloud icon

Infomaniak Public Cloud

Interact with Infomaniak Public Cloud API

Actions70

Kubernetes Service > Instance Pools → List Instance Pools

AI-generated

Summary

List Kubernetes instance pools in a specified Infomaniak Public Cloud project.

Inputs

  • authentication (required) — Authentication method; either OAuth2 or API Key.
  • path_public_cloud_id (required) — Identifier of the public cloud.
  • path_public_cloud_project_id (required) — Identifier of the cloud project.
  • path_kaas_id (required) — Kaas ID of the target infrastructure.
  • queryParameters — Additional query parameters for filtering and pagination.
  • returnAll — If true, returns all items without pagination limits.
  • limit — Maximum number of items to return (default 50, max 500).
  • returnFullResponse — If true, includes full response details.

Output shape

Array of instance pool objects; when query_return=total returns a numeric total count instead.

Results are paginated via limit, skip, page, per_page, order_by, order, order_for; optional parameters can be omitted. Errors propagate as standard API error responses.

Examples

Example 1: List all instance pools with default pagination.

authentication=apiKey, path_public_cloud_id=1, path_public_cloud_project_id=10, path_kaas_id=5

Example 2: Count instance pools without retrieving items.

authentication=oauth2, path_public_cloud_id=1, path_public_cloud_project_id=10, path_kaas_id=5, queryParameters={query_return=total}

Example 3: Paginated retrieval of 20 items starting from offset 40.

authentication=apiKey, path_public_cloud_id=1, path_public_cloud_project_id=10, path_kaas_id=5, queryParameters={query_limit=20, query_skip=40}

Links

Discussion