\HelmMainCallsAPI

All URIs are relative to https://api.qovery.com

Method	HTTP request	Description
DeleteHelm	Delete /helm/{helmId}	Delete helm
EditHelm	Put /helm/{helmId}	Edit helm
GetHelm	Get /helm/{helmId}	Get helm by ID
GetHelmKubernetesServices	Get /helm/{helmId}/listServices	Get helm kubernetes services
GetHelmStatus	Get /helm/{helmId}/status	Get helm status
ListHelmCommit	Get /helm/{helmId}/commit	List last helm commits
ListHelmLinks	Get /helm/{helmId}/link	List all URLs of the helm

DeleteHelm

DeleteHelm(ctx, helmId).Execute()

Delete helm

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Helm ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.HelmMainCallsAPI.DeleteHelm(context.Background(), helmId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.DeleteHelm``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string	Helm ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteHelmRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditHelm

HelmResponse EditHelm(ctx, helmId).HelmRequest(helmRequest).Execute()

Edit helm

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Helm ID
	helmRequest := *openapiclient.NewHelmRequest("Name_example", false, openapiclient.HelmRequest_allOf_source{HelmRequestAllOfSourceOneOf: openapiclient.NewHelmRequestAllOfSourceOneOf()}, []string{"Arguments_example"}, *openapiclient.NewHelmRequestAllOfValuesOverride()) // HelmRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HelmMainCallsAPI.EditHelm(context.Background(), helmId).HelmRequest(helmRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.EditHelm``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditHelm`: HelmResponse
	fmt.Fprintf(os.Stdout, "Response from `HelmMainCallsAPI.EditHelm`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string	Helm ID

Other Parameters

Other parameters are passed through a pointer to a apiEditHelmRequest struct via the builder pattern

Name	Type	Description	Notes

helmRequest | HelmRequest | |

Return type

HelmResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHelm

HelmResponse GetHelm(ctx, helmId).Execute()

Get helm by ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Helm ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HelmMainCallsAPI.GetHelm(context.Background(), helmId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.GetHelm``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetHelm`: HelmResponse
	fmt.Fprintf(os.Stdout, "Response from `HelmMainCallsAPI.GetHelm`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string	Helm ID

Other Parameters

Other parameters are passed through a pointer to a apiGetHelmRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

HelmResponse

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHelmKubernetesServices

KubernetesServiceResponseList GetHelmKubernetesServices(ctx, helmId).Execute()

Get helm kubernetes services

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "helmId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HelmMainCallsAPI.GetHelmKubernetesServices(context.Background(), helmId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.GetHelmKubernetesServices``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetHelmKubernetesServices`: KubernetesServiceResponseList
	fmt.Fprintf(os.Stdout, "Response from `HelmMainCallsAPI.GetHelmKubernetesServices`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetHelmKubernetesServicesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

KubernetesServiceResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetHelmStatus

Status GetHelmStatus(ctx, helmId).Execute()

Get helm status

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Helm ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HelmMainCallsAPI.GetHelmStatus(context.Background(), helmId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.GetHelmStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetHelmStatus`: Status
	fmt.Fprintf(os.Stdout, "Response from `HelmMainCallsAPI.GetHelmStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string	Helm ID

Other Parameters

Other parameters are passed through a pointer to a apiGetHelmStatusRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Status

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListHelmCommit

CommitResponseList ListHelmCommit(ctx, helmId).Of(of).Execute()

List last helm commits

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Helm ID
	of := "of_example" // string | Source of git commit. Can be 'chart' or 'values' (optional) (default to "chart")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HelmMainCallsAPI.ListHelmCommit(context.Background(), helmId).Of(of).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.ListHelmCommit``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListHelmCommit`: CommitResponseList
	fmt.Fprintf(os.Stdout, "Response from `HelmMainCallsAPI.ListHelmCommit`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string	Helm ID

Other Parameters

Other parameters are passed through a pointer to a apiListHelmCommitRequest struct via the builder pattern

Name	Type	Description	Notes

of | string | Source of git commit. Can be 'chart' or 'values' | [default to "chart"]

Return type

CommitResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListHelmLinks

LinkResponseList ListHelmLinks(ctx, helmId).Execute()

List all URLs of the helm

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	helmId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Helm ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HelmMainCallsAPI.ListHelmLinks(context.Background(), helmId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HelmMainCallsAPI.ListHelmLinks``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListHelmLinks`: LinkResponseList
	fmt.Fprintf(os.Stdout, "Response from `HelmMainCallsAPI.ListHelmLinks`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
helmId	string	Helm ID

Other Parameters

Other parameters are passed through a pointer to a apiListHelmLinksRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

LinkResponseList

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

HelmMainCallsAPI.md

Latest commit

History

HelmMainCallsAPI.md

File metadata and controls

\HelmMainCallsAPI

DeleteHelm

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EditHelm

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetHelm

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetHelmKubernetesServices

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetHelmStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListHelmCommit

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListHelmLinks

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers