\ContainerRegistriesAPI

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

Method	HTTP request	Description
CreateContainerRegistry	Post /organization/{organizationId}/containerRegistry	Create a container registry
DeleteContainerRegistry	Delete /organization/{organizationId}/containerRegistry/{containerRegistryId}	Delete a container registry
EditContainerRegistry	Put /organization/{organizationId}/containerRegistry/{containerRegistryId}	Edit a container registry
GetContainerRegistry	Get /organization/{organizationId}/containerRegistry/{containerRegistryId}	Get a container registry
GetContainerVersions	Get /organization/{organizationId}/containerRegistry/{containerRegistryId}/images	List image version for a container registry
ListAvailableContainerRegistry	Get /availableContainerRegistry	List supported container registries
ListContainerRegistry	Get /organization/{organizationId}/containerRegistry	List organization container registries

CreateContainerRegistry

ContainerRegistryResponse CreateContainerRegistry(ctx, organizationId).ContainerRegistryRequest(containerRegistryRequest).Execute()

Create a container registry

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
	containerRegistryRequest := *openapiclient.NewContainerRegistryRequest("Name_example", openapiclient.ContainerRegistryKindEnum("ECR"), *openapiclient.NewContainerRegistryRequestConfig()) // ContainerRegistryRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ContainerRegistriesAPI.CreateContainerRegistry(context.Background(), organizationId).ContainerRegistryRequest(containerRegistryRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ContainerRegistriesAPI.CreateContainerRegistry``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateContainerRegistry`: ContainerRegistryResponse
	fmt.Fprintf(os.Stdout, "Response from `ContainerRegistriesAPI.CreateContainerRegistry`: %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 apiCreateContainerRegistryRequest struct via the builder pattern

Name	Type	Description	Notes

containerRegistryRequest | ContainerRegistryRequest | |

Return type

ContainerRegistryResponse

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]

DeleteContainerRegistry

DeleteContainerRegistry(ctx, organizationId, containerRegistryId).Execute()

Delete a container registry

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
	containerRegistryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container Registry ID

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

Path Parameters

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

Other Parameters

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

EditContainerRegistry

ContainerRegistryResponse EditContainerRegistry(ctx, organizationId, containerRegistryId).ContainerRegistryRequest(containerRegistryRequest).Execute()

Edit a container registry

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
	containerRegistryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container Registry ID
	containerRegistryRequest := *openapiclient.NewContainerRegistryRequest("Name_example", openapiclient.ContainerRegistryKindEnum("ECR"), *openapiclient.NewContainerRegistryRequestConfig()) // ContainerRegistryRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

containerRegistryRequest | ContainerRegistryRequest | |

Return type

ContainerRegistryResponse

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]

GetContainerRegistry

ContainerRegistryResponse GetContainerRegistry(ctx, organizationId, containerRegistryId).Execute()

Get a container registry

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
	containerRegistryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container Registry ID

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ContainerRegistryResponse

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]

GetContainerVersions

ContainerVersionResponseList GetContainerVersions(ctx, organizationId, containerRegistryId).ImageName(imageName).Search(search).Execute()

List image version for a container registry

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
	containerRegistryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container Registry ID
	imageName := "imageName_example" // string | container image name (optional)
	search := "search_example" // string | partial container image name to search (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ContainerRegistriesAPI.GetContainerVersions(context.Background(), organizationId, containerRegistryId).ImageName(imageName).Search(search).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ContainerRegistriesAPI.GetContainerVersions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetContainerVersions`: ContainerVersionResponseList
	fmt.Fprintf(os.Stdout, "Response from `ContainerRegistriesAPI.GetContainerVersions`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ContainerVersionResponseList

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]

ListAvailableContainerRegistry

AvailableContainerRegistryResponseList ListAvailableContainerRegistry(ctx).Execute()

List supported container registries

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AvailableContainerRegistryResponseList

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]

ListContainerRegistry

ContainerRegistryResponseList ListContainerRegistry(ctx, organizationId).Execute()

List organization container registries

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.ContainerRegistriesAPI.ListContainerRegistry(context.Background(), organizationId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ContainerRegistriesAPI.ListContainerRegistry``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListContainerRegistry`: ContainerRegistryResponseList
	fmt.Fprintf(os.Stdout, "Response from `ContainerRegistriesAPI.ListContainerRegistry`: %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 apiListContainerRegistryRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ContainerRegistryResponseList

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

ContainerRegistriesAPI.md

Latest commit

History

ContainerRegistriesAPI.md

File metadata and controls

\ContainerRegistriesAPI

CreateContainerRegistry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteContainerRegistry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

EditContainerRegistry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetContainerRegistry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetContainerVersions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListAvailableContainerRegistry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListContainerRegistry

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers