\ContainersAPI

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

Method	HTTP request	Description
AutoDeployContainerEnvironments	Post /organization/{organizationId}/container/deploy	Auto deploy containers
CloneContainer	Post /container/{containerId}/clone	Clone container
CreateContainer	Post /environment/{environmentId}/container	Create a container
GetContainerRegistryContainerStatus	Get /organization/{organizationId}/containerRegistry/{containerRegistryId}/container/status	List all container registry container statuses
GetDefaultContainerAdvancedSettings	Get /defaultContainerAdvancedSettings	List default container advanced settings
GetEnvironmentContainerStatus	Get /environment/{environmentId}/container/status	List all environment container statuses
ListContainer	Get /environment/{environmentId}/container	List containers
PreviewContainerEnvironments	Post /organization/{organizationId}/container/preview	Preview container environments

AutoDeployContainerEnvironments

Status AutoDeployContainerEnvironments(ctx, organizationId).OrganizationContainerAutoDeployRequest(organizationContainerAutoDeployRequest).Execute()

Auto deploy containers

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
    organizationContainerAutoDeployRequest := *openapiclient.NewOrganizationContainerAutoDeployRequest() // OrganizationContainerAutoDeployRequest |  (optional)

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

Name	Type	Description	Notes

organizationContainerAutoDeployRequest | OrganizationContainerAutoDeployRequest | |

Return type

Status

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]

CloneContainer

ContainerResponse CloneContainer(ctx, containerId).CloneServiceRequest(cloneServiceRequest).Execute()

Clone container

Example

package main

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

func main() {
    containerId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Container ID
    cloneServiceRequest := *openapiclient.NewCloneServiceRequest("Name_example", "EnvironmentId_example") // CloneServiceRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

cloneServiceRequest | CloneServiceRequest | |

Return type

ContainerResponse

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]

CreateContainer

ContainerResponse CreateContainer(ctx, environmentId).ContainerRequest(containerRequest).Execute()

Create a container

Example

package main

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

func main() {
    environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID
    containerRequest := *openapiclient.NewContainerRequest("Name_example", "RegistryId_example", "ImageName_example", "Tag_example", *openapiclient.NewHealthcheck()) // ContainerRequest |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

containerRequest | ContainerRequest | |

Return type

ContainerResponse

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]

GetContainerRegistryContainerStatus

ReferenceObjectStatusResponseList GetContainerRegistryContainerStatus(ctx, organizationId, containerRegistryId).Execute()

List all container registry container statuses

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

Name	Type	Description	Notes

Return type

ReferenceObjectStatusResponseList

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]

GetDefaultContainerAdvancedSettings

ContainerAdvancedSettings GetDefaultContainerAdvancedSettings(ctx).Execute()

List default container advanced settings

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.ContainersAPI.GetDefaultContainerAdvancedSettings(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ContainersAPI.GetDefaultContainerAdvancedSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDefaultContainerAdvancedSettings`: ContainerAdvancedSettings
    fmt.Fprintf(os.Stdout, "Response from `ContainersAPI.GetDefaultContainerAdvancedSettings`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ContainerAdvancedSettings

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]

GetEnvironmentContainerStatus

ReferenceObjectStatusResponseList GetEnvironmentContainerStatus(ctx, environmentId).Execute()

List all environment container statuses

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ReferenceObjectStatusResponseList

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]

ListContainer

ContainerResponseList ListContainer(ctx, environmentId).Execute()

List containers

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

ContainerResponseList

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]

PreviewContainerEnvironments

Status PreviewContainerEnvironments(ctx, organizationId).OrganizationContainerPreviewRequest(organizationContainerPreviewRequest).Execute()

Preview container environments

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
    organizationContainerPreviewRequest := *openapiclient.NewOrganizationContainerPreviewRequest() // OrganizationContainerPreviewRequest |  (optional)

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

Name	Type	Description	Notes

organizationContainerPreviewRequest | OrganizationContainerPreviewRequest | |

Return type

Status

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]

Files

ContainersAPI.md

Latest commit

History

ContainersAPI.md

File metadata and controls

\ContainersAPI

AutoDeployContainerEnvironments

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CloneContainer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateContainer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetContainerRegistryContainerStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetDefaultContainerAdvancedSettings

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetEnvironmentContainerStatus

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListContainer

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PreviewContainerEnvironments

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers