KubeCluster

List KubeClusters

List multiple KubeClusters

A KubeCluster describes a single cluster provisioned by a KubePlatform.

A KubeCluster is uniquely identified by slugified name that is unique within the set of KubeCluster name for an Account, e.g. cluster1 or k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d.

KubeClusters always have an Environment tag that is defined by the customer and allows the customer to categorize their KubeClusters.

The Version field of a KubeCluster indicates the current control plane version.

GET

kubeclusters

{
  "results": [
    {
      "account": "<string>",
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "environment": "<string>",
      "id": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "platform": "<string>",
      "title": "<string>",
      "version": "<string>",
      "$schema": "<string>",
      "description": "<string>",
      "external_id": "<string>",
      "region": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Query Parameters

continue

string

Continuation token value (used when retrieving the next page of results). Continuation token value (used when retrieving the next page of results).

integer<int64>

Number of records to show per page of results. Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter. Record filter.

Response

results

object[] | null

required

Show child attributes

results.account

string

required

Account is the ID of the Account to which this KubeCluster belongs.

results.created_by

string

required

user who created the record.

results.created_on

string<date-time>

required

timestamp of when the record was created.

results.environment

string

required

A string environment tag, defined by the customer to categorize the KubeClusterThe current cluster version for this KubeCluster.

results.id

string

required

ID is the unique identifier for the KubeCluster.

results.last_modified_by

string

required

user who last modified the record.

results.last_modified_on

string<date-time>

required

timestamp of when the record was last modified.

results.platform

string

required

The name of the KubePlatform that this KubeCluster was launched in.

results.title

string

required

Display name for the KubeCluster.

results.version

string

required

The current cluster version for this KubeCluster.

results.$schema

string<uri>

A URL to the JSON Schema for this object.

results.description

string

Optional long-form description of the KubeCluster.

results.external_id

string

Optional cloud provider-specific or customer internal identifier for the KubeCluster

results.region

string

Optional string identifier of the cloud provider-specific or internal region.

$schema

string<uri>

A URL to the JSON Schema for this object.

pagination

object

Show child attributes

pagination.continue

string | null

required

Continuation token value (used when retrieving the next page of results). Empty when no more records can be retrieved.

Create KubeClusterCreate a new KubeCluster A KubeCluster describes a single cluster provisioned by a KubePlatform. A KubeCluster is uniquely identified by slugified name that is unique within the set of KubeCluster name for an Account, e.g. cluster1 or k8scl_552fb09a-5a6a-4530-86d3-bcc0a770024d. KubeClusters always have an Environment tag that is defined by the customer and allows the customer to categorize their KubeClusters. The Version field of a KubeCluster indicates the current control plane version.

⌘I

{
  "results": [
    {
      "account": "<string>",
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "environment": "<string>",
      "id": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "platform": "<string>",
      "title": "<string>",
      "version": "<string>",
      "$schema": "<string>",
      "description": "<string>",
      "external_id": "<string>",
      "region": "<string>"
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

List KubeClusters

Query Parameters

Response