Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Kubernetes Marketplace, REST: HelmRelease.List

Written by
Updated at October 17, 2024

Retrieves the list of Helm releases in the specified Kubernetes Cluster.

HTTP request

GET https://mks.api.cloud.yandex.net/managed-kubernetes/marketplace/v1/helm-releases

Query parameters

Field

Description

clusterId

string

Required field. The ID of the Kubernetes cluster to list Helm releases from.

pageSize

string (int64)

The maximum number of results per page that should be returned.

pageToken

string

Token for pagination to retrieve the next page of results.

Response

HTTP Code: 200 - OK

{
  "helmReleases": [
    {
      "id": "string",
      "clusterId": "string",
      "appName": "string",
      "appNamespace": "string",
      "productId": "string",
      "productName": "string",
      "productVersion": "string",
      "status": "string",
      "createdAt": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

helmReleases[]

HelmRelease

List of Helm releases in the Kubernetes cluster.

nextPageToken

string

Token for retrieving the next page of Helm releases.

HelmRelease

A Helm Release.

Field

Description

id

string

ID of a helm release.

clusterId

string

ID of the Kubernetes cluster.

appName

string

Name of the application.

appNamespace

string

Namespace of the application.

productId

string

Kubernetes marketplace product id.

productName

string

Kubernetes marketplace product name.

productVersion

string

Kubernetes marketplace product version.

status

enum (Status)

Status of a helm release.

  • STATUS_UNSPECIFIED
  • UNKNOWN: Helm release status is unknown
  • DEPLOYED: Helm release deployed.
  • UNINSTALLED: Helm release uninstalled.
  • SUPERSEDED: Helm release superseded.
  • FAILED: Helm release installation failed.
  • UNINSTALLING: Helm release is being uninstalled.
  • PENDING_INSTALL: Helm release is to be installed.
  • PENDING_UPGRADE: Helm release is to be updated.
  • PENDING_ROLLBACK: Helm release is to be rolled back.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Previous
Overview
Next
Get