A container is a web application, packaged as an OCI image, that runs inside Scaleway infrastructure and scales automatically.
A container can be composed of multiple instances, depending on the scaling option configured by the user.
List all containers the caller can access (read permission).
By default, the containers listed are ordered by creation date in ascending order. This can be modified via the order_by field.
Additional parameters can be set in the query to filter, such as organization_id, project_id, and name.
path Parameters
regionThe region you want to target
query Parameters
pagepage_sizeorder_byorganization_idproject_idnamespace_idnameList all containers the caller can access (read permission). › Responses
total_countCreate a new container in a namespace.
Name must be unique inside the given namespace.
path Parameters
regionThe region you want to target
Create a new container in a namespace. › Request Body
namespace_idUnique ID of the namespace the container belongs to.
nameContainer name.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
descriptionContainer description.
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
Create a new container in a namespace. › Responses
idContainer unique ID. (UUID format)
nameContainer name.
namespace_idUnique ID of the namespace the container belongs to. (UUID format)
descriptionContainer description.
statusContainer status.
error_messageContainer last error message.
created_atContainer creation date. (RFC 3339 format)
updated_atContainer last update date. (RFC 3339 format)
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network. (UUID format)
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
public_endpointPublic URL of the container. This is the default endpoint generated by Scaleway to access the container from the Internet.
regionRegion in which the container exists.
Get the container associated with the specified ID.
path Parameters
regionThe region you want to target
container_idGet the container associated with the specified ID. › Responses
idContainer unique ID. (UUID format)
nameContainer name.
namespace_idUnique ID of the namespace the container belongs to. (UUID format)
descriptionContainer description.
statusContainer status.
error_messageContainer last error message.
created_atContainer creation date. (RFC 3339 format)
updated_atContainer last update date. (RFC 3339 format)
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network. (UUID format)
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
public_endpointPublic URL of the container. This is the default endpoint generated by Scaleway to access the container from the Internet.
regionRegion in which the container exists.
Delete the container associated with the specified ID.
It also deletes in cascade any resource linked to the container (crons, tokens, etc.).
This action cannot be undone.
path Parameters
regionThe region you want to target
container_idUUID of the container to delete.
Delete the container associated with the specified ID. › Responses
idContainer unique ID. (UUID format)
nameContainer name.
namespace_idUnique ID of the namespace the container belongs to. (UUID format)
descriptionContainer description.
statusContainer status.
error_messageContainer last error message.
created_atContainer creation date. (RFC 3339 format)
updated_atContainer last update date. (RFC 3339 format)
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network. (UUID format)
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
public_endpointPublic URL of the container. This is the default endpoint generated by Scaleway to access the container from the Internet.
regionRegion in which the container exists.
Update the container associated with the specified ID.
Only fields present in the request are updated; others are left untouched.
path Parameters
regionThe region you want to target
container_idUUID of the container to update.
Update the container associated with the specified ID. › Request Body
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
descriptionContainer description.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connection_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network.
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
Update the container associated with the specified ID. › Responses
idContainer unique ID. (UUID format)
nameContainer name.
namespace_idUnique ID of the namespace the container belongs to. (UUID format)
descriptionContainer description.
statusContainer status.
error_messageContainer last error message.
created_atContainer creation date. (RFC 3339 format)
updated_atContainer last update date. (RFC 3339 format)
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network. (UUID format)
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
public_endpointPublic URL of the container. This is the default endpoint generated by Scaleway to access the container from the Internet.
regionRegion in which the container exists.
Redeploy a container
Performs a rollout of the container by creating new instances with the latest image version and terminating the old instances.
When using mutable registry image references (e.g. my-registry-namespace/image:tag), this endpoint can be used to force the container to use
the most recent image version available in the registry.
path Parameters
regionThe region you want to target
container_idID of the container to redeploy.
Redeploy a container › Responses
idContainer unique ID. (UUID format)
nameContainer name.
namespace_idUnique ID of the namespace the container belongs to. (UUID format)
descriptionContainer description.
statusContainer status.
error_messageContainer last error message.
created_atContainer creation date. (RFC 3339 format)
updated_atContainer last update date. (RFC 3339 format)
Environment variables of the container.
Secret environment variables of the container.
min_scaleMinimum number of instances to scale the container to.
max_scaleMaximum number of instances to scale the container to.
memory_limit_bytesMemory limit of the container in bytes. (in bytes)
mvcpu_limitCPU limit of the container in mvCPU.
local_storage_limit_bytesLocal storage limit of the container (in bytes). (in bytes)
timeoutProcessing time limit for the container. (in seconds)
privacyPrivacy policy of the container.
imageImage reference (e.g. "rg.fr-par.scw.cloud/my-registry-namespace/image:tag").
protocolProtocol the container uses.
portPort the container listens on.
https_connections_onlyIf true, it will allow only HTTPS connections to access your container to prevent it from being triggered by insecure connections (HTTP).
sandboxExecution environment of the container.
Parameter used to decide when to scale up or down.
Defines how to check if the container is running and healthy. If the liveness probe fails, the container will be restarted. It is performed periodically during the container's lifetime. The liveness probe is not executed until the startup probe (if defined) is successful.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
Defines how to check if the container has started successfully. If the startup probe fails, the container will be restarted. This check is useful for applications that might take a long time to start. It is only performed when the container is starting.
Possible check types:
- http: Perform HTTP check on the container with the specified path.
- tcp: Perform TCP check on the container.
tagsTags of the Serverless Container.
private_network_idID of the Private Network the container is connected to. When connected to a Private Network, the container can access other Scaleway resources in this Private Network. (UUID format)
commandContainer command. Command executed when the container starts. This overrides the default command defined in the container image. This is usually the main executable, or ENTRYPOINT script to run.
argsContainer arguments. Arguments passed to the command specified in the "command" field. These override the default arguments from the container image, and behave like command-line parameters.
public_endpointPublic URL of the container. This is the default endpoint generated by Scaleway to access the container from the Internet.
regionRegion in which the container exists.