Get

/kubernetes-clusters

Query parameters

cursor

string

limit

integer

Default100

order_by

string

Sort order - ascending (asc) or descending (desc)

Valid values[ "asc", "desc" ]

Default"asc"

Responses

200

A list of Kubernetes Clusters

Expand All

object

pagination

object

next_cursor

string

The cursor for the next page

previous_cursor

string

The cursor for the last page

data

Array of object (KubernetesCluster)

object

name

string

A name for the resource.

Examplenaomis-resource

description

string

A description of the resource.

ExampleA good and detailed description that makes everyone understand.

tags

Array of string

Custom tags for organizing and categorizing resources in the GUI.

Max items32

Example[ "tagA", "tagB", "tagC" ]

string

id

integer (int64)

A globally unique identifier (ID) for the resource.

guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

tenant_guid

string (uuid)

A globally unique identifier (GUID) for the resource.

Examplea7f4aa24-a00d-4dc5-a113-2031eb8c2c79

owner

object (UserID)

Represents the owner of the resource.

id

string

The unique identifier for the owner.

id_type

string

The type of identifier for the owner.

Valid values[ "uid", "vid", "sid", "access_key", "sid_str", "login_name", "username" ]

name

string

The presentable name of the owner

created_at

string (date-time)

Timestamp when the resource was created.

Example2024-12-25T15:30:00Z

updated_at

string (date-time)

Timestamp when the resource was last updated.

Example2024-12-28T18:00:00Z

vrn

string

A logical path for resource grouping and policy assignment. The structure of the logical path is: vast:dataengine:: where resource type is one of: triggers / functions / pipelines / topics / kubernetes-clusters / container-registries / mtls-authentication-credentials.

Examplevast:dataengine:functions:foo

kube_api_url

string

Examplehttps://k8s.example.com

mtls_credentials_guid

string (uuid)

A GUID of the kubernetes credentials object created.

Example204108a4-b40f-4b37-9bd9-6300628ebe15

namespaces

Array of string

The namespaces in the kubernetes cluster.

Example[ "insight-engine-prod", "insight-engine-dev" ]

string

Exampleinsight-engine-prod

is_internal

boolean

Whether this is an internal VAST-managed cluster. Defaults to false (external cluster).

Defaultfalse

status

string

Operational status of the object.

Valid values[ "Ready", "InProgress", "Error", "Draft", "Deleting" ]

ExampleReady

List all Kubernetes Clusters