\ArgoCDAPI

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

Method	HTTP request	Description
CheckArgoCdConnection	Post /cluster/{clusterId}/argoCdConfig/check	Check ArgoCD connection
DeleteArgoCdCredentials	Delete /cluster/{clusterId}/argoCdConfig	Delete ArgoCD credentials for a cluster
DeleteArgoCdDestinationClusterMapping	Delete /organization/{organizationId}/argoCdDestinationClusterMapping	Delete an ArgoCD destination cluster mapping
GetArgoCdApp	Get /argocdApp/{argocdAppId}	Get ArgoCD app by ID
GetArgoCdAppManifest	Get /argocdApp/{argocdAppId}/manifest	Get ArgoCD app manifest enrichment
GetArgoCdAssociatedServices	Get /cluster/{clusterId}/argocdApps/associatedServices	Get ArgoCD associated services for a cluster
GetArgoCdCredentials	Get /cluster/{clusterId}/argoCdConfig	Get ArgoCD credentials for a cluster
ListArgoCdDestinationClusterMappings	Get /organization/{organizationId}/argoCdDestinationClusterMapping	List ArgoCD instance mappings for an organization
SaveArgoCdCredentials	Post /cluster/{clusterId}/argoCdConfig	Save ArgoCD credentials for a cluster
SaveArgoCdDestinationClusterMapping	Post /organization/{organizationId}/argoCdDestinationClusterMapping	Save an ArgoCD destination cluster mapping

CheckArgoCdConnection

ArgoCdConnectionCheckResponse CheckArgoCdConnection(ctx, clusterId).ArgoCdCredentialsRequest(argoCdCredentialsRequest).Execute()

Check ArgoCD connection

Example

package main

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

func main() {
	clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID
	argoCdCredentialsRequest := *openapiclient.NewArgoCdCredentialsRequest("https://argocd.example.com", "ArgocdToken_example") // ArgoCdCredentialsRequest | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

argoCdCredentialsRequest | ArgoCdCredentialsRequest | |

Return type

ArgoCdConnectionCheckResponse

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]

DeleteArgoCdCredentials

DeleteArgoCdCredentials(ctx, clusterId).Execute()

Delete ArgoCD credentials for a cluster

Example

package main

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

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ArgoCDAPI.DeleteArgoCdCredentials(context.Background(), clusterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ArgoCDAPI.DeleteArgoCdCredentials``: %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.
clusterId	string	Cluster ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteArgoCdCredentialsRequest 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]

DeleteArgoCdDestinationClusterMapping

DeleteArgoCdDestinationClusterMapping(ctx, organizationId).AgentClusterId(agentClusterId).ArgocdClusterUrl(argocdClusterUrl).Execute()

Delete an ArgoCD destination cluster mapping

Example

package main

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

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	agentClusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | ID of the Qovery cluster where the ArgoCD instance is running
	argocdClusterUrl := "https://kubernetes.default.svc" // string | ArgoCD destination cluster URL as reported by ArgoCD

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ArgoCDAPI.DeleteArgoCdDestinationClusterMapping(context.Background(), organizationId).AgentClusterId(agentClusterId).ArgocdClusterUrl(argocdClusterUrl).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ArgoCDAPI.DeleteArgoCdDestinationClusterMapping``: %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.
organizationId	string	Organization ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteArgoCdDestinationClusterMappingRequest 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]

GetArgoCdApp

ArgocdAppResponse GetArgoCdApp(ctx, argocdAppId).Execute()

Get ArgoCD app by ID

Example

package main

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

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

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
argocdAppId	string	ArgoCD App ID

Other Parameters

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

Name	Type	Description	Notes

Return type

ArgocdAppResponse

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]

GetArgoCdAppManifest

ArgocdAppManifestResponse GetArgoCdAppManifest(ctx, argocdAppId).Execute()

Get ArgoCD app manifest enrichment

Example

package main

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

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

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
argocdAppId	string	ArgoCD App ID

Other Parameters

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

Name	Type	Description	Notes

Return type

ArgocdAppManifestResponse

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]

GetArgoCdAssociatedServices

ArgocdAssociatedServicesResponseList GetArgoCdAssociatedServices(ctx, clusterId).Execute()

Get ArgoCD associated services for a cluster

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ArgocdAssociatedServicesResponseList

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]

GetArgoCdCredentials

ArgoCdCredentialsResponse GetArgoCdCredentials(ctx, clusterId).Execute()

Get ArgoCD credentials for a cluster

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ArgoCdCredentialsResponse

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]

ListArgoCdDestinationClusterMappings

ArgoCdInstanceMappingResponseList ListArgoCdDestinationClusterMappings(ctx, organizationId).Execute()

List ArgoCD instance mappings for an organization

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ArgoCdInstanceMappingResponseList

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]

SaveArgoCdCredentials

ArgoCdCredentialsResponse SaveArgoCdCredentials(ctx, clusterId).ArgoCdCredentialsRequest(argoCdCredentialsRequest).Execute()

Save ArgoCD credentials for a cluster

Example

package main

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

func main() {
	clusterId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Cluster ID
	argoCdCredentialsRequest := *openapiclient.NewArgoCdCredentialsRequest("https://argocd.example.com", "ArgocdToken_example") // ArgoCdCredentialsRequest | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

argoCdCredentialsRequest | ArgoCdCredentialsRequest | |

Return type

ArgoCdCredentialsResponse

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]

SaveArgoCdDestinationClusterMapping

ArgoCdDestinationClusterMappingResponse SaveArgoCdDestinationClusterMapping(ctx, organizationId).ArgoCdDestinationClusterMappingRequest(argoCdDestinationClusterMappingRequest).Execute()

Save an ArgoCD destination cluster mapping

Example

package main

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

func main() {
	organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Organization ID
	argoCdDestinationClusterMappingRequest := *openapiclient.NewArgoCdDestinationClusterMappingRequest("AgentClusterId_example", "https://kubernetes.default.svc", "ClusterId_example") // ArgoCdDestinationClusterMappingRequest | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

argoCdDestinationClusterMappingRequest | ArgoCdDestinationClusterMappingRequest | |

Return type

ArgoCdDestinationClusterMappingResponse

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]

FilesExpand file tree

ArgoCDAPI.md

Latest commit

History

ArgoCDAPI.md

File metadata and controls

\ArgoCDAPI

CheckArgoCdConnection

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteArgoCdCredentials

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteArgoCdDestinationClusterMapping

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArgoCdApp

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArgoCdAppManifest

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArgoCdAssociatedServices

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetArgoCdCredentials

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListArgoCdDestinationClusterMappings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SaveArgoCdCredentials

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SaveArgoCdDestinationClusterMapping

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers