endpoints_api.md

List Helm Releases

Returns List installed helm charts in JSON

• URL

  /api/helm/releases

• Method:

  GET

• URL Params

  ns=[string] - Namespace

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { error : "error message" }

Get Helm Release

Returns installed helm release in JSON

• URL

  /api/helm/release

• Method:

  GET

• URL Params

  ns=[string] - Namespace

  name=[string] - Helm Release Name

• Success Response:

  • Code: 200
    
  • JSON encoded Release structure

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { error : "error message" }

Get Helm Release History

Returns installed helm release history in JSON

• URL

  /api/helm/release/history

• Method:

  GET

• URL Params

  ns=[string] - Namespace

  name=[string] - Helm Release Name

• Success Response:

  • Code: 200
    
  • JSON encoded array of Release structure

• Error Response:

  • Code: 502 BAD GATEWAY
    Content: { error : "error message" }

  • Code: 404 NOT FOUND
    Content: { error : "error message" }

Install Helm Release

Install Helm release

• URL

  /api/helm/release

• Method:

  POST

• Post Data Params

 {
   name: [string],
   namespace: [string]
   chart_url: [string]
   values: map[string]interface{}
  }

• Example Request

    {
    	"name": "test-helm-release",
    	"namespace": "default",
    	"chart_url": "https://github.com/akashshinde/console/raw/helm_endpoints/pkg/helm/testdata/influxdb-3.0.2.tgz"
        "values": { "service": {"type": "ClusterIP"} }
    }

• Success Response:

  • Code: 200
    
  • JSON encoded Release structure

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { error : "error message" }

Uninstall Helm Release

Uninstall Helm release

• URL

  /api/helm/release

• Method:

  DELETE

• URL Params

  ns=[string] - Namespace

  name=[string] - Helm Release Name

• Success Response:

  • Code: 200
    

  • JSON encoded UninstallReleaseResponse structure

  • Code: 404 NOT FOUND
    Content: { error : "error message" }

• Error Response:

  • Code: 502 BAD GATEWAY
    Content: { error : "error message" }

Upgrade Helm Release

Upgrade Helm release

• URL

  /api/helm/release

• Method:

  PUT

• Put Data Params

 {
   name: [string],
   namespace: [string]
   chart_url: [string]
   values: map[string]interface{}
  }

• Example Request

    {
    	"name": "test-helm-release",
    	"namespace": "default",
    	"chart_url": "https://github.com/akashshinde/console/raw/helm_endpoints/pkg/helm/testdata/influxdb-3.0.2.tgz"
        "values": { "service": {"type": "ClusterIP"} }
    }

• Success Response:

  • Code: 200
    
  • JSON encoded Release structure

• Error Response:

  • Code: 502 BAD GATEWAY
    Content: { error : "error message" }

  • Code: 404 NOT FOUND
    Content: { error : "error message" }

Rollback Helm Release

Rollback Helm release

• URL

  /api/helm/release

• Method:

  PATCH

• Put Data Params

 {
   name: [string],
   namespace: [string]
   version: [int]
  }

• Example Request

    {
    	"name": "test-helm-release",
    	"namespace": "default",
        "version": 1,
    }

• Success Response:

  • Code: 200
    
  • JSON encoded Release structure

• Error Response:

  • Code: 502 BAD GATEWAY
    Content: { error : "error message" }

  • Code: 404 NOT FOUND
    Content: { error : "error message" }

Render Helm Template/Manifests

Simulates helm template command

• URL

  /api/helm/template

• Method:

  POST

• Post Data Params

 {
   name: [string],
   namespace: [string]
   chart_url: [string]
   value: map[string]interface{}
  }

• Example Request

    {
    	"name": "test-helm-release",
    	"namespace": "default",
    	"chart_url": "https://github.com/akashshinde/console/raw/helm_endpoints/pkg/helm/testdata/influxdb-3.0.2.tgz"
        "values": { "service": {"type": "ClusterIP"} }
    }

• Success Response:

  • Code: 200
    

• Error Response:

  • Code: 502 BAD REQUEST
    Content: { error : "error message" }

Retrieve a Chart

Returns all chart details for the given chart URL

• URL

  /api/helm/chart

• Method:

  GET

• URL Params

  url=[string] - Chart URL

• Success Response:

  • Code: 200
    
  • JSON representation of Chart structure

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { error : "error message" }

Retrieve Helm Repository Index

Returns repository index file containing all entries from all configured repositories

• URL

  /api/helm/charts/index.yaml

• Method:

  GET

• Supported URL Query Parameter:

  • onlyCompatible - true/false Setting true would return helm charts which are supported in the provided cluster. Default value is set to true if not provided.

• Success Response:

  • Code: 200
    
  • JSON representation of Index file
  • Each entry key is appended with source repo name. Double dash (--) serves as the separate between the chart and repo name (e.g. foo-chart--my-repo)

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { error : "error message" }