Skip to main content

List Kubernetes Clusters

Returns a paginated list of the Kubernetes clusters in the project. Each entry summarises the cluster's master role, state, Kubernetes version, master plan and pricing, encryption/backup flags, and the committed-pricing options. Use page_no and per_page to page through results.

GET/api/v1/kubernetes/

Query parameters

  • page_noQueryintegeroptional

    1-based page number to retrieve.

    • optional
    • positive integer
    • defaults to 1 when omitted
    example1
  • per_pageQueryintegeroptional

    Number of clusters to return per page.

    • optional
    • positive integer
    • defaults to 5 when omitted
    example5
  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region to filter clusters by.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object
codeinteger
example200
dataarray

Clusters in the project.

errorsobject
messagestring
exampleSuccess