Skip to main content

List all clusters for your organization

GET 
/api/v1/clusters

Retrieves a list of all Kubernetes clusters managed by the platform.

Request​

Query Parameters

    providerId string

    Possible values: [aws, gcp]

    Cloud Provider Id

Header Parameters

    X-API-KEY stringrequired

    API Key

Responses​

List of clusters, not including sensitive information

Schema

    data

    object[]

  • Array [

    • addOnService

    object[]

    addOnService represents the add-on services installed on the cluster

  • Array [

    • createdTimestamp string

    createdTimestamp is the timestamp when the add-on service was created

    lastUpdatedTimestamp string

    lastUpdatedTimestamp is the timestamp of the last update to the add-on service

    name string

    Name is the name of the add-on service

    version string

    version is the version of the add-on service

  • ]

    • application

    object[]

    application represents the applications deployed on the cluster

  • Array [

    • createdTimestamp string

    createdTimestamp is the timestamp when the application was created

    dnsEndpoint string

    dnsEndpoint is the DNS endpoint for accessing the application

    inputSourceType string

    inputSourceType represents the type of input source for the application

    lastUpdatedTimestamp string

    lastUpdatedTimestamp is the timestamp of the last update to the application

    name string

    name is the name of the application

  • ]

    • architecture string

    architecture represents the cluster architecture

    clusterFQDN string

    clusterFQDN is the fully qualified domain name of the cluster

    clusterId string

    clusterId is the unique identifier for the cluster

    clusterName string

    clusterName is the name of the cluster

    controlPlaneNode

    object

    controlPlaneNode represents the control plane node configuration

    availabilityZones string[]

    availabilityZones is the list of availability zones If the list is empty then node group will be created in all the availability zones supported by the region and the provider

    instanceType stringrequired

    Possible values: [ondemand, spot]

    instanceType is the type of the instance, The supported types are ondemand and spot

    labels

    object

    labels to be applied to the nodes in this group

    property name* string
    machineTypes string[]required

    list of machine types for the nodes in this group

    maxNode integerrequired

    maximum number of nodes in the group

    minNode integerrequired

    minimum number of nodes in the group

    name stringrequired

    Possible values: non-empty and <= 50 characters

    name of the node group, must be a valid DNS name

    taints

    object[]

    taints to be applied to the nodes in this group

  • Array [

    • effect string

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    effect indicates the taint effect to match can be NoSchedule, PreferNoSchedule or NoExecute

    key stringrequired

    Possible values: non-empty

    key is the taint key that the toleration applies to

    operator string

    Possible values: [Equal, Exists, NotExist, NotEqual]

    operator represents a key's relationship to the value Valid operators are Exists and Equal

    value stringrequired

    Possible values: non-empty

    value is the taint value the toleration matches to If the operator is Exists, the value should be empty

  • ]

    • kubernetesVersion string

    KubernetesVersion is the version of Kubernetes running on the cluster

    lastUpdatedTimestamp string

    lastUpdatedTimestamp is the timestamp of the last update to the cluster

    provider string

    Provider is the cloud provider hosting the cluster

    provisionerType string

    Possible values: [eks, gke, aks, selfHosted]

    Provisioner is the provisioner spec for the cluster

    region string

    region is the geographical region where the cluster is deployed

    state string

    state represents the current state of the cluster

    totalMonthlyCost string

    totalMonthlyCost represents the estimated monthly cost of the cluster

    workerNodes

    object[]

    workerNode represents the worker node configurations

  • Array [

    • availabilityZones string[]

    availabilityZones is the list of availability zones If the list is empty then node group will be created in all the availability zones supported by the region and the provider

    instanceType stringrequired

    Possible values: [ondemand, spot]

    instanceType is the type of the instance, The supported types are ondemand and spot

    labels

    object

    labels to be applied to the nodes in this group

    property name* string
    machineTypes string[]required

    list of machine types for the nodes in this group

    maxNode integerrequired

    maximum number of nodes in the group

    minNode integerrequired

    minimum number of nodes in the group

    name stringrequired

    Possible values: non-empty and <= 50 characters

    name of the node group, must be a valid DNS name

    taints

    object[]

    taints to be applied to the nodes in this group

  • Array [

    • effect string

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    effect indicates the taint effect to match can be NoSchedule, PreferNoSchedule or NoExecute

    key stringrequired

    Possible values: non-empty

    key is the taint key that the toleration applies to

    operator string

    Possible values: [Equal, Exists, NotExist, NotEqual]

    operator represents a key's relationship to the value Valid operators are Exists and Equal

    value stringrequired

    Possible values: non-empty

    value is the taint value the toleration matches to If the operator is Exists, the value should be empty

  • ]

  • ]

  • ]

    • id string
    message string
    status string
Loading...