Skip to main content

List of clusters

GET 
/clusters

The operation allows you to retrieve a collection of all available clusters. A cluster constitutes a managed group of interconnected worker nodes that run containerized applications.

Request​

Query Parameters

    allowedOps string[]

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

List of clusters

Schema

  • Array [

    • id stringrequired


    The unique identifier of the cluster.

    name stringrequired


    The user-friendly name or label for the cluster. It allows users to provide a clear and descriptive name that helps in identifying and distinguishing different clusters easily. The field accepts free text with alphanumeric and special characters.
    If the displayName is not explicitly set during creation, the cluster name will be used as the default displayName, ensuring the cluster has a recognizable and unique label.

    description stringnullable


    The detailed textual description of the cluster. Allows users to add additional context, notes, or any relevant information about the purpose, usage, or characteristics of the cluster.

    domain stringrequired


    The fully qualified domain name used to access the services running in the cluster.

    primary booleanrequired


    A boolean flag indicating whether the cluster is the primary (or default) cluster for the associated account.

    enabled booleanrequired


    A boolean flag indicating whether the cluster is enabled for use. If set to false, the cluster is suspended and unavailable.

    createdAt date-timerequired


    The timestamp denoting when the cluster was created. It is an automatically generated value that records the exact date and time when the cluster was added to the system.

    updatedAt date-timerequired


    The timestamp denoting when the cluster was last updated. It is an automatically generated value that records the exact date and time when the cluster configuration was changed.

    version stringrequired


    The current version of the cluster. Version can change when the cluster configuration is updated.

    creationStatus stringrequired


    The current life-cycle status of the cluster.

    requestedBy stringrequired


    The username of the user who requested the creation of the cluster.

    workerNodes

    object[]


    A list of objects representing the configuration of worker nodes in the cluster. Each object contains details about a specific type of worker node, including the common cloud provider and the count of nodes of that type.

  • Array [

    • cloudProvider stringrequired


    Name of the cloud provider used to provision the worker nodes in the cluster. This value remains the same across all worker nodes in the cluster.

    workerNodeType stringrequired


    Type or instance size of the worker nodes.

    workerNodeCount int32required


    Number of worker nodes of given type in the cluster.

  • ]

    • selfHosted booleanrequired


    A boolean flag indicating whether the cluster is managed by the customer. If set to false, the cluster is registered under, and managed by, CodeNOW.

    readyForChanges booleanrequired


    A boolean flag indicating whether the cluster is ready for reconfiguration.

  • ]

Loading...