All URIs are relative to https://api.qovery.com
| Method | HTTP request | Description |
|---|---|---|
| GetClusterPlatformBinding | Get /organization/{organizationId}/cluster/{clusterId}/platformBinding | Get the cluster platform binding |
| ListPlatformTemplates | Get /organization/{organizationId}/platformTemplate | List platform templates |
| ResolvePlatformComponentConfiguration | Post /organization/{organizationId}/cluster/{clusterId}/platformBinding/component/{componentKey}/resolve | Resolve a platform component configuration |
| ResolvePlatformTemplateComponentConfiguration | Post /organization/{organizationId}/platformTemplate/{templateKey}/{templateVersion}/component/{componentKey}/resolve | Resolve a platform component configuration before cluster creation |
| UpdateClusterPlatformBinding | Put /organization/{organizationId}/cluster/{clusterId}/platformBinding | Update the cluster platform binding |
ClusterPlatformBindingResponse GetClusterPlatformBinding(ctx, organizationId, clusterId).Execute()
Get the cluster platform binding
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.PlatformConfigurationAPI.GetClusterPlatformBinding(context.Background(), organizationId, clusterId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PlatformConfigurationAPI.GetClusterPlatformBinding``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetClusterPlatformBinding`: ClusterPlatformBindingResponse
fmt.Fprintf(os.Stdout, "Response from `PlatformConfigurationAPI.GetClusterPlatformBinding`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID | |
| clusterId | string | Cluster ID |
Other parameters are passed through a pointer to a apiGetClusterPlatformBindingRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
ClusterPlatformBindingResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PlatformTemplateCatalogResponse ListPlatformTemplates(ctx, organizationId).ClusterMode(clusterMode).CloudProvider(cloudProvider).Execute()
List platform templates
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
clusterMode := openapiclient.PlatformClusterMode("QOVERY_MANAGED") // PlatformClusterMode | Cluster management mode. Must be supplied together with cloudProvider. (optional)
cloudProvider := openapiclient.PlatformCloudVendor("AWS") // PlatformCloudVendor | Cluster cloud provider. Must be supplied together with clusterMode. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.PlatformConfigurationAPI.ListPlatformTemplates(context.Background(), organizationId).ClusterMode(clusterMode).CloudProvider(cloudProvider).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PlatformConfigurationAPI.ListPlatformTemplates``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListPlatformTemplates`: PlatformTemplateCatalogResponse
fmt.Fprintf(os.Stdout, "Response from `PlatformConfigurationAPI.ListPlatformTemplates`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID |
Other parameters are passed through a pointer to a apiListPlatformTemplatesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
clusterMode | PlatformClusterMode | Cluster management mode. Must be supplied together with cloudProvider. | cloudProvider | PlatformCloudVendor | Cluster cloud provider. Must be supplied together with clusterMode. |
PlatformTemplateCatalogResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PlatformComponentConfigurationPreviewResponse ResolvePlatformComponentConfiguration(ctx, organizationId, clusterId, componentKey).PlatformComponentConfigurationPreviewRequest(platformComponentConfigurationPreviewRequest).Execute()
Resolve a platform component configuration
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID
componentKey := "componentKey_example" // string | Platform component key
platformComponentConfigurationPreviewRequest := *openapiclient.NewPlatformComponentConfigurationPreviewRequest() // PlatformComponentConfigurationPreviewRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.PlatformConfigurationAPI.ResolvePlatformComponentConfiguration(context.Background(), organizationId, clusterId, componentKey).PlatformComponentConfigurationPreviewRequest(platformComponentConfigurationPreviewRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PlatformConfigurationAPI.ResolvePlatformComponentConfiguration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ResolvePlatformComponentConfiguration`: PlatformComponentConfigurationPreviewResponse
fmt.Fprintf(os.Stdout, "Response from `PlatformConfigurationAPI.ResolvePlatformComponentConfiguration`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID | |
| clusterId | string | Cluster ID | |
| componentKey | string | Platform component key |
Other parameters are passed through a pointer to a apiResolvePlatformComponentConfigurationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
platformComponentConfigurationPreviewRequest | PlatformComponentConfigurationPreviewRequest | |
PlatformComponentConfigurationPreviewResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PlatformComponentConfigurationResolutionResponse ResolvePlatformTemplateComponentConfiguration(ctx, organizationId, templateKey, templateVersion, componentKey).ClusterMode(clusterMode).CloudProvider(cloudProvider).PlatformComponentConfigurationPreviewRequest(platformComponentConfigurationPreviewRequest).Execute()
Resolve a platform component configuration before cluster creation
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
templateKey := "templateKey_example" // string | Platform template key
templateVersion := "templateVersion_example" // string | Platform template version
componentKey := "componentKey_example" // string | Platform component key
clusterMode := openapiclient.PlatformClusterMode("QOVERY_MANAGED") // PlatformClusterMode | Cluster management mode used to resolve component applicability
cloudProvider := openapiclient.PlatformCloudVendor("AWS") // PlatformCloudVendor | Cluster cloud provider used to resolve component applicability
platformComponentConfigurationPreviewRequest := *openapiclient.NewPlatformComponentConfigurationPreviewRequest() // PlatformComponentConfigurationPreviewRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.PlatformConfigurationAPI.ResolvePlatformTemplateComponentConfiguration(context.Background(), organizationId, templateKey, templateVersion, componentKey).ClusterMode(clusterMode).CloudProvider(cloudProvider).PlatformComponentConfigurationPreviewRequest(platformComponentConfigurationPreviewRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PlatformConfigurationAPI.ResolvePlatformTemplateComponentConfiguration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ResolvePlatformTemplateComponentConfiguration`: PlatformComponentConfigurationResolutionResponse
fmt.Fprintf(os.Stdout, "Response from `PlatformConfigurationAPI.ResolvePlatformTemplateComponentConfiguration`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID | |
| templateKey | string | Platform template key | |
| templateVersion | string | Platform template version | |
| componentKey | string | Platform component key |
Other parameters are passed through a pointer to a apiResolvePlatformTemplateComponentConfigurationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
clusterMode | PlatformClusterMode | Cluster management mode used to resolve component applicability | cloudProvider | PlatformCloudVendor | Cluster cloud provider used to resolve component applicability | platformComponentConfigurationPreviewRequest | PlatformComponentConfigurationPreviewRequest | |
PlatformComponentConfigurationResolutionResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ClusterPlatformBindingResponse UpdateClusterPlatformBinding(ctx, organizationId, clusterId).ClusterPlatformBindingRequest(clusterPlatformBindingRequest).Execute()
Update the cluster platform binding
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/qovery/qovery-client-go"
)
func main() {
organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID
clusterPlatformBindingRequest := *openapiclient.NewClusterPlatformBindingRequest("TemplateKey_example", "TemplateVersion_example") // ClusterPlatformBindingRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.PlatformConfigurationAPI.UpdateClusterPlatformBinding(context.Background(), organizationId, clusterId).ClusterPlatformBindingRequest(clusterPlatformBindingRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `PlatformConfigurationAPI.UpdateClusterPlatformBinding``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateClusterPlatformBinding`: ClusterPlatformBindingResponse
fmt.Fprintf(os.Stdout, "Response from `PlatformConfigurationAPI.UpdateClusterPlatformBinding`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| organizationId | string | Organization ID | |
| clusterId | string | Cluster ID |
Other parameters are passed through a pointer to a apiUpdateClusterPlatformBindingRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
clusterPlatformBindingRequest | ClusterPlatformBindingRequest | |
ClusterPlatformBindingResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]