ContainersApi.md

\ContainersApi

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

Method	HTTP request	Description
auto_deploy_container_environments	POST /organization/{organizationId}/container/deploy	Auto deploy containers
clone_container	POST /container/{containerId}/clone	Clone container
create_container	POST /environment/{environmentId}/container	Create a container
get_container_registry_container_status	GET /organization/{organizationId}/containerRegistry/{containerRegistryId}/container/status	List all container registry container statuses
get_default_container_advanced_settings	GET /defaultContainerAdvancedSettings	List default container advanced settings
get_environment_container_status	GET /environment/{environmentId}/container/status	List all environment container statuses
list_container	GET /environment/{environmentId}/container	List containers
preview_container_environments	POST /organization/{organizationId}/container/preview	Preview container environments

auto_deploy_container_environments

models::Status auto_deploy_container_environments(organization_id, organization_container_auto_deploy_request) Auto deploy containers

Triggers a new container deploy in each environment matching the following conditions - environment should have the auto-deploy enabled - the container should have the same image name and a different tag

Parameters

Name	Type	Description	Required	Notes
organization_id	uuid::Uuid	Organization ID	[required]
organization_container_auto_deploy_request	Option<OrganizationContainerAutoDeployRequest>

Return type

models::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]

clone_container

models::ContainerResponse clone_container(container_id, clone_service_request) Clone container

This will create a new container with the same configuration on the targeted environment Id.

Parameters

Name	Type	Description	Required	Notes
container_id	uuid::Uuid	Container ID	[required]
clone_service_request	Option<CloneServiceRequest>

Return type

models::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]

create_container

models::ContainerResponse create_container(environment_id, container_request) Create a container

Parameters

Name	Type	Description	Required	Notes
environment_id	uuid::Uuid	Environment ID	[required]
container_request	Option<ContainerRequest>

Return type

models::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]

get_container_registry_container_status

models::ReferenceObjectStatusResponseList get_container_registry_container_status(organization_id, container_registry_id) List all container registry container statuses

Returns a list of containers with only their id and status.

Parameters

Name	Type	Description	Required	Notes
organization_id	uuid::Uuid	Organization ID	[required]
container_registry_id	uuid::Uuid	Container Registry ID	[required]

Return type

models::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]

get_default_container_advanced_settings

models::ContainerAdvancedSettings get_default_container_advanced_settings() List default container advanced settings

Default values for each setting are available in our documentation

Parameters

This endpoint does not need any parameter.

Return type

models::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]

get_environment_container_status

models::ReferenceObjectStatusResponseList get_environment_container_status(environment_id) List all environment container statuses

Returns a list of containers with only their id and status.

Parameters

Name	Type	Description	Required	Notes
environment_id	uuid::Uuid	Environment ID	[required]

Return type

models::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]

list_container

models::ContainerResponseList list_container(environment_id) List containers

Parameters

Name	Type	Description	Required	Notes
environment_id	uuid::Uuid	Environment ID	[required]

Return type

models::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]

preview_container_environments

models::Status preview_container_environments(organization_id, organization_container_preview_request) Preview container environments

Triggers a new container preview for each environment matching the following conditions - preview environment feature should be enabled for the container - the container should have the same image name and a different tag

Parameters

Name	Type	Description	Required	Notes
organization_id	uuid::Uuid	Organization ID	[required]
organization_container_preview_request	Option<OrganizationContainerPreviewRequest>

Return type

models::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]